vanta-auditor-api-sdk 0.4.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (839) hide show
  1. package/FUNCTIONS.md +2 -2
  2. package/README.md +65 -105
  3. package/docs/sdks/auditors/README.md +1 -2
  4. package/docs/sdks/audits/README.md +1884 -102
  5. package/examples/{auditsList.example.ts → auditorsCreate.example.ts} +6 -2
  6. package/funcs/auditorsCreate.d.ts.map +1 -1
  7. package/funcs/auditorsCreate.js +2 -1
  8. package/funcs/auditorsCreate.js.map +1 -1
  9. package/funcs/auditsAcceptInformationRequestEvidence.d.ts +31 -0
  10. package/funcs/auditsAcceptInformationRequestEvidence.d.ts.map +1 -0
  11. package/funcs/auditsAcceptInformationRequestEvidence.js +139 -0
  12. package/funcs/auditsAcceptInformationRequestEvidence.js.map +1 -0
  13. package/funcs/auditsCreateCommentForEvidence.d.ts.map +1 -1
  14. package/funcs/auditsCreateCommentForEvidence.js +2 -1
  15. package/funcs/auditsCreateCommentForEvidence.js.map +1 -1
  16. package/funcs/auditsCreateCommentForInformationRequest.d.ts +20 -0
  17. package/funcs/auditsCreateCommentForInformationRequest.d.ts.map +1 -0
  18. package/funcs/auditsCreateCommentForInformationRequest.js +130 -0
  19. package/funcs/auditsCreateCommentForInformationRequest.js.map +1 -0
  20. package/funcs/auditsCreateCustomControl.d.ts.map +1 -1
  21. package/funcs/auditsCreateCustomControl.js +2 -1
  22. package/funcs/auditsCreateCustomControl.js.map +1 -1
  23. package/funcs/auditsCreateCustomEvidenceRequest.d.ts.map +1 -1
  24. package/funcs/auditsCreateCustomEvidenceRequest.js +2 -1
  25. package/funcs/auditsCreateCustomEvidenceRequest.js.map +1 -1
  26. package/funcs/auditsCreateInformationRequest.d.ts +25 -0
  27. package/funcs/auditsCreateInformationRequest.d.ts.map +1 -0
  28. package/funcs/auditsCreateInformationRequest.js +131 -0
  29. package/funcs/auditsCreateInformationRequest.js.map +1 -0
  30. package/funcs/auditsDeleteCommentForInformationRequest.d.ts +19 -0
  31. package/funcs/auditsDeleteCommentForInformationRequest.d.ts.map +1 -0
  32. package/funcs/auditsDeleteCommentForInformationRequest.js +132 -0
  33. package/funcs/auditsDeleteCommentForInformationRequest.js.map +1 -0
  34. package/funcs/auditsDeleteInformationRequest.d.ts +27 -0
  35. package/funcs/auditsDeleteInformationRequest.d.ts.map +1 -0
  36. package/funcs/auditsDeleteInformationRequest.js +135 -0
  37. package/funcs/auditsDeleteInformationRequest.js.map +1 -0
  38. package/funcs/auditsFlagInformationRequestEvidence.d.ts +33 -0
  39. package/funcs/auditsFlagInformationRequestEvidence.d.ts.map +1 -0
  40. package/funcs/auditsFlagInformationRequestEvidence.js +143 -0
  41. package/funcs/auditsFlagInformationRequestEvidence.js.map +1 -0
  42. package/funcs/auditsGetAudit.d.ts +22 -0
  43. package/funcs/auditsGetAudit.d.ts.map +1 -0
  44. package/funcs/auditsGetAudit.js +125 -0
  45. package/funcs/auditsGetAudit.js.map +1 -0
  46. package/funcs/auditsGetEvidenceUrls.d.ts +2 -0
  47. package/funcs/auditsGetEvidenceUrls.d.ts.map +1 -1
  48. package/funcs/auditsGetEvidenceUrls.js +4 -1
  49. package/funcs/auditsGetEvidenceUrls.js.map +1 -1
  50. package/funcs/auditsGetFrameworkCodes.d.ts +23 -0
  51. package/funcs/auditsGetFrameworkCodes.d.ts.map +1 -0
  52. package/funcs/auditsGetFrameworkCodes.js +126 -0
  53. package/funcs/auditsGetFrameworkCodes.js.map +1 -0
  54. package/funcs/auditsGetInformationRequest.d.ts +23 -0
  55. package/funcs/auditsGetInformationRequest.d.ts.map +1 -0
  56. package/funcs/auditsGetInformationRequest.js +130 -0
  57. package/funcs/auditsGetInformationRequest.js.map +1 -0
  58. package/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.d.ts +30 -0
  59. package/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.d.ts.map +1 -0
  60. package/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.js +143 -0
  61. package/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.js.map +1 -0
  62. package/funcs/auditsList.d.ts +4 -0
  63. package/funcs/auditsList.d.ts.map +1 -1
  64. package/funcs/auditsList.js +6 -1
  65. package/funcs/auditsList.js.map +1 -1
  66. package/funcs/auditsListAuditIssues.d.ts +33 -0
  67. package/funcs/auditsListAuditIssues.d.ts.map +1 -0
  68. package/funcs/auditsListAuditIssues.js +143 -0
  69. package/funcs/auditsListAuditIssues.js.map +1 -0
  70. package/funcs/auditsListAuditSnapshots.d.ts +31 -0
  71. package/funcs/auditsListAuditSnapshots.d.ts.map +1 -0
  72. package/funcs/auditsListAuditSnapshots.js +140 -0
  73. package/funcs/auditsListAuditSnapshots.js.map +1 -0
  74. package/funcs/auditsListComments.d.ts.map +1 -1
  75. package/funcs/auditsListComments.js +2 -1
  76. package/funcs/auditsListComments.js.map +1 -1
  77. package/funcs/auditsListCommentsForInformationRequest.d.ts +39 -0
  78. package/funcs/auditsListCommentsForInformationRequest.d.ts.map +1 -0
  79. package/funcs/auditsListCommentsForInformationRequest.js +152 -0
  80. package/funcs/auditsListCommentsForInformationRequest.js.map +1 -0
  81. package/funcs/auditsListControls.d.ts.map +1 -1
  82. package/funcs/auditsListControls.js +2 -1
  83. package/funcs/auditsListControls.js.map +1 -1
  84. package/funcs/auditsListEvidence.d.ts.map +1 -1
  85. package/funcs/auditsListEvidence.js +2 -1
  86. package/funcs/auditsListEvidence.js.map +1 -1
  87. package/funcs/auditsListInformationRequestActivity.d.ts +35 -0
  88. package/funcs/auditsListInformationRequestActivity.d.ts.map +1 -0
  89. package/funcs/auditsListInformationRequestActivity.js +148 -0
  90. package/funcs/auditsListInformationRequestActivity.js.map +1 -0
  91. package/funcs/auditsListInformationRequestEvidence.d.ts +39 -0
  92. package/funcs/auditsListInformationRequestEvidence.d.ts.map +1 -0
  93. package/funcs/auditsListInformationRequestEvidence.js +153 -0
  94. package/funcs/auditsListInformationRequestEvidence.js.map +1 -0
  95. package/funcs/auditsListInformationRequests.d.ts +39 -0
  96. package/funcs/auditsListInformationRequests.d.ts.map +1 -0
  97. package/funcs/auditsListInformationRequests.js +148 -0
  98. package/funcs/auditsListInformationRequests.js.map +1 -0
  99. package/funcs/auditsListInformationRequestsForControl.d.ts +34 -0
  100. package/funcs/auditsListInformationRequestsForControl.d.ts.map +1 -0
  101. package/funcs/auditsListInformationRequestsForControl.js +146 -0
  102. package/funcs/auditsListInformationRequestsForControl.js.map +1 -0
  103. package/funcs/auditsShareInformationRequestList.d.ts +20 -0
  104. package/funcs/auditsShareInformationRequestList.d.ts.map +1 -0
  105. package/funcs/auditsShareInformationRequestList.js +123 -0
  106. package/funcs/auditsShareInformationRequestList.js.map +1 -0
  107. package/funcs/auditsUpdateCommentForInformationRequest.d.ts +20 -0
  108. package/funcs/auditsUpdateCommentForInformationRequest.d.ts.map +1 -0
  109. package/funcs/auditsUpdateCommentForInformationRequest.js +132 -0
  110. package/funcs/auditsUpdateCommentForInformationRequest.js.map +1 -0
  111. package/funcs/auditsUpdateEvidence.d.ts.map +1 -1
  112. package/funcs/auditsUpdateEvidence.js +2 -1
  113. package/funcs/auditsUpdateEvidence.js.map +1 -1
  114. package/funcs/auditsUpdateInformationRequest.d.ts +28 -0
  115. package/funcs/auditsUpdateInformationRequest.d.ts.map +1 -0
  116. package/funcs/auditsUpdateInformationRequest.js +138 -0
  117. package/funcs/auditsUpdateInformationRequest.js.map +1 -0
  118. package/jsr.json +1 -1
  119. package/lib/config.d.ts +4 -4
  120. package/lib/config.d.ts.map +1 -1
  121. package/lib/config.js +5 -9
  122. package/lib/config.js.map +1 -1
  123. package/lib/encodings.d.ts +2 -0
  124. package/lib/encodings.d.ts.map +1 -1
  125. package/lib/encodings.js +39 -6
  126. package/lib/encodings.js.map +1 -1
  127. package/lib/files.d.ts +13 -0
  128. package/lib/files.d.ts.map +1 -1
  129. package/lib/files.js +19 -0
  130. package/lib/files.js.map +1 -1
  131. package/lib/matchers.d.ts.map +1 -1
  132. package/lib/matchers.js +0 -1
  133. package/lib/matchers.js.map +1 -1
  134. package/lib/sdks.d.ts +1 -1
  135. package/lib/sdks.d.ts.map +1 -1
  136. package/lib/sdks.js +12 -10
  137. package/lib/sdks.js.map +1 -1
  138. package/lib/security.d.ts +1 -1
  139. package/lib/security.d.ts.map +1 -1
  140. package/lib/security.js +20 -10
  141. package/lib/security.js.map +1 -1
  142. package/lib/url.d.ts.map +1 -1
  143. package/lib/url.js +4 -2
  144. package/lib/url.js.map +1 -1
  145. package/models/components/acceptinformationrequestevidenceinput.d.ts +25 -0
  146. package/models/components/acceptinformationrequestevidenceinput.d.ts.map +1 -0
  147. package/models/components/acceptinformationrequestevidenceinput.js +49 -0
  148. package/models/components/acceptinformationrequestevidenceinput.js.map +1 -0
  149. package/models/components/addauditorinput.d.ts +0 -5
  150. package/models/components/addauditorinput.d.ts.map +1 -1
  151. package/models/components/addauditorinput.js +1 -12
  152. package/models/components/addauditorinput.js.map +1 -1
  153. package/models/components/addcommentinput.d.ts +0 -5
  154. package/models/components/addcommentinput.d.ts.map +1 -1
  155. package/models/components/addcommentinput.js +1 -12
  156. package/models/components/addcommentinput.js.map +1 -1
  157. package/models/components/addinformationrequestcommentinput.d.ts +44 -0
  158. package/models/components/addinformationrequestcommentinput.d.ts.map +1 -0
  159. package/models/components/addinformationrequestcommentinput.js +51 -0
  160. package/models/components/addinformationrequestcommentinput.js.map +1 -0
  161. package/models/components/audit.d.ts +31 -21
  162. package/models/components/audit.d.ts.map +1 -1
  163. package/models/components/audit.js +11 -23
  164. package/models/components/audit.js.map +1 -1
  165. package/models/components/auditevidencestate.d.ts +0 -2
  166. package/models/components/auditevidencestate.d.ts.map +1 -1
  167. package/models/components/auditevidencestate.js +1 -3
  168. package/models/components/auditevidencestate.js.map +1 -1
  169. package/models/components/auditevidencetype.d.ts +0 -2
  170. package/models/components/auditevidencetype.d.ts.map +1 -1
  171. package/models/components/auditevidencetype.js +1 -3
  172. package/models/components/auditevidencetype.js.map +1 -1
  173. package/models/components/auditevidenceupdateinput.d.ts +0 -8
  174. package/models/components/auditevidenceupdateinput.d.ts.map +1 -1
  175. package/models/components/auditevidenceupdateinput.js +1 -19
  176. package/models/components/auditevidenceupdateinput.js.map +1 -1
  177. package/models/components/auditfocus.d.ts +0 -2
  178. package/models/components/auditfocus.d.ts.map +1 -1
  179. package/models/components/auditfocus.js +1 -3
  180. package/models/components/auditfocus.js.map +1 -1
  181. package/models/components/auditor.d.ts +0 -11
  182. package/models/components/auditor.d.ts.map +1 -1
  183. package/models/components/auditor.js +1 -13
  184. package/models/components/auditor.js.map +1 -1
  185. package/models/components/auditorcontrol.d.ts +10 -28
  186. package/models/components/auditorcontrol.d.ts.map +1 -1
  187. package/models/components/auditorcontrol.js +3 -29
  188. package/models/components/auditorcontrol.js.map +1 -1
  189. package/models/components/auditorenabledstatetransition.d.ts +0 -2
  190. package/models/components/auditorenabledstatetransition.d.ts.map +1 -1
  191. package/models/components/auditorenabledstatetransition.js +2 -4
  192. package/models/components/auditorenabledstatetransition.js.map +1 -1
  193. package/models/components/comment.d.ts +9 -13
  194. package/models/components/comment.d.ts.map +1 -1
  195. package/models/components/comment.js +2 -15
  196. package/models/components/comment.js.map +1 -1
  197. package/models/components/control.d.ts +9 -25
  198. package/models/components/control.d.ts.map +1 -1
  199. package/models/components/control.js +3 -27
  200. package/models/components/control.js.map +1 -1
  201. package/models/components/controldomain.d.ts +0 -2
  202. package/models/components/controldomain.d.ts.map +1 -1
  203. package/models/components/controldomain.js +2 -4
  204. package/models/components/controldomain.js.map +1 -1
  205. package/models/components/controlsource.d.ts +0 -2
  206. package/models/components/controlsource.d.ts.map +1 -1
  207. package/models/components/controlsource.js +1 -3
  208. package/models/components/controlsource.js.map +1 -1
  209. package/models/components/createcustomcontrolinput.d.ts +0 -7
  210. package/models/components/createcustomcontrolinput.d.ts.map +1 -1
  211. package/models/components/createcustomcontrolinput.js +2 -19
  212. package/models/components/createcustomcontrolinput.js.map +1 -1
  213. package/models/components/createcustomevidencerequestinput.d.ts +0 -5
  214. package/models/components/createcustomevidencerequestinput.d.ts.map +1 -1
  215. package/models/components/createcustomevidencerequestinput.js +1 -16
  216. package/models/components/createcustomevidencerequestinput.js.map +1 -1
  217. package/models/components/createinformationrequestinput.d.ts +98 -0
  218. package/models/components/createinformationrequestinput.d.ts.map +1 -0
  219. package/models/components/createinformationrequestinput.js +70 -0
  220. package/models/components/createinformationrequestinput.js.map +1 -0
  221. package/models/components/customevidencerequest.d.ts +0 -13
  222. package/models/components/customevidencerequest.d.ts.map +1 -1
  223. package/models/components/customevidencerequest.js +1 -15
  224. package/models/components/customevidencerequest.js.map +1 -1
  225. package/models/components/customfield.d.ts +0 -13
  226. package/models/components/customfield.d.ts.map +1 -1
  227. package/models/components/customfield.js +1 -16
  228. package/models/components/customfield.js.map +1 -1
  229. package/models/components/deleteinformationrequestcommentinput.d.ts +25 -0
  230. package/models/components/deleteinformationrequestcommentinput.d.ts.map +1 -0
  231. package/models/components/deleteinformationrequestcommentinput.js +49 -0
  232. package/models/components/deleteinformationrequestcommentinput.js.map +1 -0
  233. package/models/components/evidence.d.ts +1 -19
  234. package/models/components/evidence.d.ts.map +1 -1
  235. package/models/components/evidence.js +1 -20
  236. package/models/components/evidence.js.map +1 -1
  237. package/models/components/evidencecontrol.d.ts +0 -8
  238. package/models/components/evidencecontrol.d.ts.map +1 -1
  239. package/models/components/evidencecontrol.js +1 -10
  240. package/models/components/evidencecontrol.js.map +1 -1
  241. package/models/components/evidenceurl.d.ts +4 -10
  242. package/models/components/evidenceurl.d.ts.map +1 -1
  243. package/models/components/evidenceurl.js +2 -12
  244. package/models/components/evidenceurl.js.map +1 -1
  245. package/models/components/flaginformationrequestevidenceinput.d.ts +36 -0
  246. package/models/components/flaginformationrequestevidenceinput.d.ts.map +1 -0
  247. package/models/components/flaginformationrequestevidenceinput.js +50 -0
  248. package/models/components/flaginformationrequestevidenceinput.js.map +1 -0
  249. package/models/components/frameworkcodes.d.ts +19 -0
  250. package/models/components/frameworkcodes.d.ts.map +1 -0
  251. package/models/components/frameworkcodes.js +50 -0
  252. package/models/components/frameworkcodes.js.map +1 -0
  253. package/models/components/frameworkid.d.ts +0 -2
  254. package/models/components/frameworkid.d.ts.map +1 -1
  255. package/models/components/frameworkid.js +2 -4
  256. package/models/components/frameworkid.js.map +1 -1
  257. package/models/components/frameworksection.d.ts +0 -8
  258. package/models/components/frameworksection.d.ts.map +1 -1
  259. package/models/components/frameworksection.js +1 -17
  260. package/models/components/frameworksection.js.map +1 -1
  261. package/models/components/index.d.ts +41 -0
  262. package/models/components/index.d.ts.map +1 -1
  263. package/models/components/index.js +41 -0
  264. package/models/components/index.js.map +1 -1
  265. package/models/components/informationrequest.d.ts +191 -0
  266. package/models/components/informationrequest.d.ts.map +1 -0
  267. package/models/components/informationrequest.js +110 -0
  268. package/models/components/informationrequest.js.map +1 -0
  269. package/models/components/informationrequestactivitylog.d.ts +110 -0
  270. package/models/components/informationrequestactivitylog.d.ts.map +1 -0
  271. package/models/components/informationrequestactivitylog.js +89 -0
  272. package/models/components/informationrequestactivitylog.js.map +1 -0
  273. package/models/components/informationrequestactivitytype.d.ts +13 -0
  274. package/models/components/informationrequestactivitytype.d.ts.map +1 -0
  275. package/{mcp-server/tools/auditsList.js → models/components/informationrequestactivitytype.js} +11 -25
  276. package/models/components/informationrequestactivitytype.js.map +1 -0
  277. package/models/components/informationrequestapprovalstatus.d.ts +28 -0
  278. package/models/components/informationrequestapprovalstatus.d.ts.map +1 -0
  279. package/{mcp-server/tools/auditorsCreate.js → models/components/informationrequestapprovalstatus.js} +18 -25
  280. package/models/components/informationrequestapprovalstatus.js.map +1 -0
  281. package/models/components/informationrequestcadence.d.ts +18 -0
  282. package/models/components/informationrequestcadence.d.ts.map +1 -0
  283. package/{mcp-server/tools/auditsUpdateEvidence.js → models/components/informationrequestcadence.js} +13 -25
  284. package/models/components/informationrequestcadence.js.map +1 -0
  285. package/models/components/informationrequestcomment.d.ts +72 -0
  286. package/models/components/informationrequestcomment.d.ts.map +1 -0
  287. package/models/components/informationrequestcomment.js +56 -0
  288. package/models/components/informationrequestcomment.js.map +1 -0
  289. package/models/components/informationrequestevidence.d.ts +59 -0
  290. package/models/components/informationrequestevidence.d.ts.map +1 -0
  291. package/models/components/informationrequestevidence.js +58 -0
  292. package/models/components/informationrequestevidence.js.map +1 -0
  293. package/models/components/informationrequestevidenceunion.d.ts +21 -0
  294. package/models/components/informationrequestevidenceunion.d.ts.map +1 -0
  295. package/models/components/informationrequestevidenceunion.js +63 -0
  296. package/models/components/informationrequestevidenceunion.js.map +1 -0
  297. package/models/components/informationrequestsupportedevidencetype.d.ts +17 -0
  298. package/models/components/informationrequestsupportedevidencetype.d.ts.map +1 -0
  299. package/{mcp-server/tools/auditsListControls.js → models/components/informationrequestsupportedevidencetype.js} +16 -25
  300. package/models/components/informationrequestsupportedevidencetype.js.map +1 -0
  301. package/models/components/informationrequesttype.d.ts +31 -0
  302. package/models/components/informationrequesttype.d.ts.map +1 -0
  303. package/models/components/informationrequesttype.js +59 -0
  304. package/models/components/informationrequesttype.js.map +1 -0
  305. package/models/components/issuesnapshotitem.d.ts +65 -0
  306. package/models/components/issuesnapshotitem.d.ts.map +1 -0
  307. package/models/components/issuesnapshotitem.js +63 -0
  308. package/models/components/issuesnapshotitem.js.map +1 -0
  309. package/models/components/issuesnapshotmetadata.d.ts +25 -0
  310. package/models/components/issuesnapshotmetadata.d.ts.map +1 -0
  311. package/models/components/issuesnapshotmetadata.js +54 -0
  312. package/models/components/issuesnapshotmetadata.js.map +1 -0
  313. package/models/components/issuestatustypeforsnapshot.d.ts +11 -0
  314. package/models/components/issuestatustypeforsnapshot.d.ts.map +1 -0
  315. package/models/components/issuestatustypeforsnapshot.js +48 -0
  316. package/models/components/issuestatustypeforsnapshot.js.map +1 -0
  317. package/models/components/linkevidence.d.ts +24 -0
  318. package/models/components/linkevidence.d.ts.map +1 -0
  319. package/models/components/linkevidence.js +52 -0
  320. package/models/components/linkevidence.js.map +1 -0
  321. package/models/components/observationevidence.d.ts +16 -0
  322. package/models/components/observationevidence.d.ts.map +1 -0
  323. package/models/components/observationevidence.js +50 -0
  324. package/models/components/observationevidence.js.map +1 -0
  325. package/models/components/pageinfo.d.ts +0 -10
  326. package/models/components/pageinfo.d.ts.map +1 -1
  327. package/models/components/pageinfo.js +1 -12
  328. package/models/components/pageinfo.js.map +1 -1
  329. package/models/components/paginatedissuesnapshotitemsresponse.d.ts +22 -0
  330. package/models/components/paginatedissuesnapshotitemsresponse.d.ts.map +1 -0
  331. package/models/components/paginatedissuesnapshotitemsresponse.js +61 -0
  332. package/models/components/paginatedissuesnapshotitemsresponse.js.map +1 -0
  333. package/models/components/paginatedissuesnapshotmetadataresponse.d.ts +22 -0
  334. package/models/components/paginatedissuesnapshotmetadataresponse.d.ts.map +1 -0
  335. package/models/components/paginatedissuesnapshotmetadataresponse.js +61 -0
  336. package/models/components/paginatedissuesnapshotmetadataresponse.js.map +1 -0
  337. package/models/components/paginatedresponseaudit.d.ts +2 -17
  338. package/models/components/paginatedresponseaudit.d.ts.map +1 -1
  339. package/models/components/paginatedresponseaudit.js +1 -18
  340. package/models/components/paginatedresponseaudit.js.map +1 -1
  341. package/models/components/paginatedresponseauditorcontrol.d.ts +2 -17
  342. package/models/components/paginatedresponseauditorcontrol.d.ts.map +1 -1
  343. package/models/components/paginatedresponseauditorcontrol.js +1 -18
  344. package/models/components/paginatedresponseauditorcontrol.js.map +1 -1
  345. package/models/components/paginatedresponsecomment.d.ts +2 -17
  346. package/models/components/paginatedresponsecomment.d.ts.map +1 -1
  347. package/models/components/paginatedresponsecomment.js +1 -18
  348. package/models/components/paginatedresponsecomment.js.map +1 -1
  349. package/models/components/paginatedresponseevidence.d.ts +2 -17
  350. package/models/components/paginatedresponseevidence.d.ts.map +1 -1
  351. package/models/components/paginatedresponseevidence.js +1 -18
  352. package/models/components/paginatedresponseevidence.js.map +1 -1
  353. package/models/components/paginatedresponseevidenceurl.d.ts +2 -17
  354. package/models/components/paginatedresponseevidenceurl.d.ts.map +1 -1
  355. package/models/components/paginatedresponseevidenceurl.js +1 -18
  356. package/models/components/paginatedresponseevidenceurl.js.map +1 -1
  357. package/models/components/paginatedresponseinformationrequest.d.ts +22 -0
  358. package/models/components/paginatedresponseinformationrequest.d.ts.map +1 -0
  359. package/models/components/paginatedresponseinformationrequest.js +61 -0
  360. package/models/components/paginatedresponseinformationrequest.js.map +1 -0
  361. package/models/components/paginatedresponseinformationrequestactivitylog.d.ts +22 -0
  362. package/models/components/paginatedresponseinformationrequestactivitylog.d.ts.map +1 -0
  363. package/models/components/paginatedresponseinformationrequestactivitylog.js +61 -0
  364. package/models/components/paginatedresponseinformationrequestactivitylog.js.map +1 -0
  365. package/models/components/paginatedresponseinformationrequestcomment.d.ts +22 -0
  366. package/models/components/paginatedresponseinformationrequestcomment.d.ts.map +1 -0
  367. package/models/components/paginatedresponseinformationrequestcomment.js +61 -0
  368. package/models/components/paginatedresponseinformationrequestcomment.js.map +1 -0
  369. package/models/components/paginatedresponseinformationrequestevidence.d.ts +22 -0
  370. package/models/components/paginatedresponseinformationrequestevidence.d.ts.map +1 -0
  371. package/models/components/paginatedresponseinformationrequestevidence.js +61 -0
  372. package/models/components/paginatedresponseinformationrequestevidence.js.map +1 -0
  373. package/models/components/partialupdateinformationrequest.d.ts +69 -0
  374. package/models/components/partialupdateinformationrequest.d.ts.map +1 -0
  375. package/{mcp-server/tools/auditsCreateCustomEvidenceRequest.js → models/components/partialupdateinformationrequest.js} +20 -26
  376. package/models/components/partialupdateinformationrequest.js.map +1 -0
  377. package/models/components/recurrenceduration.d.ts +1 -0
  378. package/models/components/recurrenceduration.d.ts.map +1 -1
  379. package/models/components/recurrenceduration.js +1 -0
  380. package/models/components/recurrenceduration.js.map +1 -1
  381. package/models/components/section.d.ts +20 -8
  382. package/models/components/section.d.ts.map +1 -1
  383. package/models/components/section.js +9 -8
  384. package/models/components/section.js.map +1 -1
  385. package/models/components/security.d.ts +0 -5
  386. package/models/components/security.d.ts.map +1 -1
  387. package/models/components/security.js +1 -10
  388. package/models/components/security.js.map +1 -1
  389. package/models/components/updateinformationrequestcommentinput.d.ts +34 -0
  390. package/models/components/updateinformationrequestcommentinput.d.ts.map +1 -0
  391. package/models/components/updateinformationrequestcommentinput.js +50 -0
  392. package/models/components/updateinformationrequestcommentinput.js.map +1 -0
  393. package/models/components/uploadeddocumentevidence.d.ts +41 -0
  394. package/models/components/uploadeddocumentevidence.d.ts.map +1 -0
  395. package/models/components/uploadeddocumentevidence.js +53 -0
  396. package/models/components/uploadeddocumentevidence.js.map +1 -0
  397. package/models/components/vantadocumentevidence.d.ts +78 -0
  398. package/models/components/vantadocumentevidence.d.ts.map +1 -0
  399. package/models/components/vantadocumentevidence.js +79 -0
  400. package/models/components/vantadocumentevidence.js.map +1 -0
  401. package/models/components/vantadocumentlinkevidence.d.ts +27 -0
  402. package/models/components/vantadocumentlinkevidence.d.ts.map +1 -0
  403. package/models/components/vantadocumentlinkevidence.js +52 -0
  404. package/models/components/vantadocumentlinkevidence.js.map +1 -0
  405. package/models/components/vantadocumentuploadedevidence.d.ts +45 -0
  406. package/models/components/vantadocumentuploadedevidence.d.ts.map +1 -0
  407. package/models/components/vantadocumentuploadedevidence.js +54 -0
  408. package/models/components/vantadocumentuploadedevidence.js.map +1 -0
  409. package/models/components/vantapolicyevidence.d.ts +126 -0
  410. package/models/components/vantapolicyevidence.d.ts.map +1 -0
  411. package/models/components/vantapolicyevidence.js +79 -0
  412. package/models/components/vantapolicyevidence.js.map +1 -0
  413. package/models/components/vantatestevidence.d.ts +71 -0
  414. package/models/components/vantatestevidence.d.ts.map +1 -0
  415. package/models/components/vantatestevidence.js +67 -0
  416. package/models/components/vantatestevidence.js.map +1 -0
  417. package/models/components/vantatestfiletype.d.ts +12 -0
  418. package/models/components/vantatestfiletype.d.ts.map +1 -0
  419. package/models/components/vantatestfiletype.js +49 -0
  420. package/models/components/vantatestfiletype.js.map +1 -0
  421. package/models/components/vantatestrunstatus.d.ts +14 -0
  422. package/models/components/vantatestrunstatus.d.ts.map +1 -0
  423. package/models/components/vantatestrunstatus.js +51 -0
  424. package/models/components/vantatestrunstatus.js.map +1 -0
  425. package/models/components/vantatestsnapshotevidence.d.ts +68 -0
  426. package/models/components/vantatestsnapshotevidence.d.ts.map +1 -0
  427. package/{mcp-server/tools/auditsCreateCommentForEvidence.js → models/components/vantatestsnapshotevidence.js} +29 -25
  428. package/models/components/vantatestsnapshotevidence.js.map +1 -0
  429. package/models/components/vantatestsnapshotevidencedetail.d.ts +66 -0
  430. package/models/components/vantatestsnapshotevidencedetail.d.ts.map +1 -0
  431. package/models/components/vantatestsnapshotevidencedetail.js +76 -0
  432. package/models/components/vantatestsnapshotevidencedetail.js.map +1 -0
  433. package/models/components/vantatestsnapshotintegration.d.ts +14 -0
  434. package/models/components/vantatestsnapshotintegration.d.ts.map +1 -0
  435. package/models/components/vantatestsnapshotintegration.js +51 -0
  436. package/models/components/vantatestsnapshotintegration.js.map +1 -0
  437. package/models/components/vantatestsnapshotrawtestdatarow.d.ts +41 -0
  438. package/models/components/vantatestsnapshotrawtestdatarow.d.ts.map +1 -0
  439. package/models/components/vantatestsnapshotrawtestdatarow.js +52 -0
  440. package/models/components/vantatestsnapshotrawtestdatarow.js.map +1 -0
  441. package/models/operations/acceptinformationrequestevidence.d.ts +17 -0
  442. package/models/operations/acceptinformationrequestevidence.d.ts.map +1 -0
  443. package/models/operations/acceptinformationrequestevidence.js +57 -0
  444. package/models/operations/acceptinformationrequestevidence.js.map +1 -0
  445. package/models/operations/createcommentforauditevidence.d.ts +0 -5
  446. package/models/operations/createcommentforauditevidence.d.ts.map +1 -1
  447. package/models/operations/createcommentforauditevidence.js +1 -16
  448. package/models/operations/createcommentforauditevidence.js.map +1 -1
  449. package/models/operations/createcommentforinformationrequest.d.ts +17 -0
  450. package/models/operations/createcommentforinformationrequest.d.ts.map +1 -0
  451. package/models/operations/createcommentforinformationrequest.js +57 -0
  452. package/models/operations/createcommentforinformationrequest.js.map +1 -0
  453. package/models/operations/createcustomcontrol.d.ts +0 -5
  454. package/models/operations/createcustomcontrol.d.ts.map +1 -1
  455. package/models/operations/createcustomcontrol.js +1 -15
  456. package/models/operations/createcustomcontrol.js.map +1 -1
  457. package/models/operations/createcustomevidencerequest.d.ts +0 -5
  458. package/models/operations/createcustomevidencerequest.d.ts.map +1 -1
  459. package/models/operations/createcustomevidencerequest.js +1 -15
  460. package/models/operations/createcustomevidencerequest.js.map +1 -1
  461. package/models/operations/createinformationrequest.d.ts +15 -0
  462. package/models/operations/createinformationrequest.d.ts.map +1 -0
  463. package/models/operations/createinformationrequest.js +56 -0
  464. package/models/operations/createinformationrequest.js.map +1 -0
  465. package/models/operations/deletecommentforinformationrequest.d.ts +19 -0
  466. package/models/operations/deletecommentforinformationrequest.d.ts.map +1 -0
  467. package/{mcp-server/tools/auditsCreateCustomControl.js → models/operations/deletecommentforinformationrequest.js} +20 -26
  468. package/models/operations/deletecommentforinformationrequest.js.map +1 -0
  469. package/models/operations/deleteinformationrequest.d.ts +14 -0
  470. package/models/operations/deleteinformationrequest.d.ts.map +1 -0
  471. package/models/operations/deleteinformationrequest.js +50 -0
  472. package/models/operations/deleteinformationrequest.js.map +1 -0
  473. package/models/operations/flaginformationrequestevidence.d.ts +17 -0
  474. package/models/operations/flaginformationrequestevidence.d.ts.map +1 -0
  475. package/{mcp-server/tools/auditsListComments.js → models/operations/flaginformationrequestevidence.js} +19 -26
  476. package/models/operations/flaginformationrequestevidence.js.map +1 -0
  477. package/models/operations/getaudit.d.ts +12 -0
  478. package/models/operations/getaudit.d.ts.map +1 -0
  479. package/models/operations/getaudit.js +49 -0
  480. package/models/operations/getaudit.js.map +1 -0
  481. package/models/operations/getframeworkcodes.d.ts +12 -0
  482. package/models/operations/getframeworkcodes.d.ts.map +1 -0
  483. package/models/operations/getframeworkcodes.js +49 -0
  484. package/models/operations/getframeworkcodes.js.map +1 -0
  485. package/models/operations/getinformationrequest.d.ts +14 -0
  486. package/models/operations/getinformationrequest.d.ts.map +1 -0
  487. package/models/operations/getinformationrequest.js +50 -0
  488. package/models/operations/getinformationrequest.js.map +1 -0
  489. package/models/operations/getinformationrequesttestsnapshotevidencedetail.d.ts +16 -0
  490. package/models/operations/getinformationrequesttestsnapshotevidencedetail.d.ts.map +1 -0
  491. package/models/operations/getinformationrequesttestsnapshotevidencedetail.js +51 -0
  492. package/models/operations/getinformationrequesttestsnapshotevidencedetail.js.map +1 -0
  493. package/models/operations/index.d.ts +20 -0
  494. package/models/operations/index.d.ts.map +1 -1
  495. package/models/operations/index.js +20 -0
  496. package/models/operations/index.js.map +1 -1
  497. package/models/operations/listauditcomments.d.ts +0 -5
  498. package/models/operations/listauditcomments.d.ts.map +1 -1
  499. package/models/operations/listauditcomments.js +1 -13
  500. package/models/operations/listauditcomments.js.map +1 -1
  501. package/models/operations/listauditcontrols.d.ts +0 -5
  502. package/models/operations/listauditcontrols.d.ts.map +1 -1
  503. package/models/operations/listauditcontrols.js +1 -12
  504. package/models/operations/listauditcontrols.js.map +1 -1
  505. package/models/operations/listauditevidence.d.ts +0 -5
  506. package/models/operations/listauditevidence.d.ts.map +1 -1
  507. package/models/operations/listauditevidence.js +1 -13
  508. package/models/operations/listauditevidence.js.map +1 -1
  509. package/models/operations/listauditevidenceurls.d.ts +0 -5
  510. package/models/operations/listauditevidenceurls.d.ts.map +1 -1
  511. package/models/operations/listauditevidenceurls.js +1 -13
  512. package/models/operations/listauditevidenceurls.js.map +1 -1
  513. package/models/operations/listauditissues.d.ts +35 -0
  514. package/models/operations/listauditissues.d.ts.map +1 -0
  515. package/models/operations/listauditissues.js +53 -0
  516. package/models/operations/listauditissues.js.map +1 -0
  517. package/models/operations/listaudits.d.ts +0 -5
  518. package/models/operations/listaudits.d.ts.map +1 -1
  519. package/models/operations/listaudits.js +1 -13
  520. package/models/operations/listaudits.js.map +1 -1
  521. package/models/operations/listauditsnapshots.d.ts +30 -0
  522. package/models/operations/listauditsnapshots.d.ts.map +1 -0
  523. package/models/operations/listauditsnapshots.js +52 -0
  524. package/models/operations/listauditsnapshots.js.map +1 -0
  525. package/models/operations/listcommentsforinformationrequest.d.ts +32 -0
  526. package/models/operations/listcommentsforinformationrequest.d.ts.map +1 -0
  527. package/models/operations/listcommentsforinformationrequest.js +53 -0
  528. package/models/operations/listcommentsforinformationrequest.js.map +1 -0
  529. package/models/operations/listinformationrequestactivity.d.ts +29 -0
  530. package/models/operations/listinformationrequestactivity.d.ts.map +1 -0
  531. package/models/operations/listinformationrequestactivity.js +53 -0
  532. package/models/operations/listinformationrequestactivity.js.map +1 -0
  533. package/models/operations/listinformationrequestevidence.d.ts +42 -0
  534. package/models/operations/listinformationrequestevidence.d.ts.map +1 -0
  535. package/models/operations/listinformationrequestevidence.js +55 -0
  536. package/models/operations/listinformationrequestevidence.js.map +1 -0
  537. package/models/operations/listinformationrequests.d.ts +30 -0
  538. package/models/operations/listinformationrequests.d.ts.map +1 -0
  539. package/models/operations/listinformationrequests.js +52 -0
  540. package/models/operations/listinformationrequests.js.map +1 -0
  541. package/models/operations/listinformationrequestsforcontrol.d.ts +24 -0
  542. package/models/operations/listinformationrequestsforcontrol.d.ts.map +1 -0
  543. package/models/operations/listinformationrequestsforcontrol.js +52 -0
  544. package/models/operations/listinformationrequestsforcontrol.js.map +1 -0
  545. package/models/operations/shareinformationrequestlist.d.ts +12 -0
  546. package/models/operations/shareinformationrequestlist.d.ts.map +1 -0
  547. package/{mcp-server/tools/auditsListEvidence.js → models/operations/shareinformationrequestlist.js} +11 -26
  548. package/models/operations/shareinformationrequestlist.js.map +1 -0
  549. package/models/operations/updateauditevidence.d.ts +0 -5
  550. package/models/operations/updateauditevidence.d.ts.map +1 -1
  551. package/models/operations/updateauditevidence.js +1 -16
  552. package/models/operations/updateauditevidence.js.map +1 -1
  553. package/models/operations/updatecommentforinformationrequest.d.ts +19 -0
  554. package/models/operations/updatecommentforinformationrequest.d.ts.map +1 -0
  555. package/models/operations/updatecommentforinformationrequest.js +58 -0
  556. package/models/operations/updatecommentforinformationrequest.js.map +1 -0
  557. package/models/operations/updateinformationrequest.d.ts +17 -0
  558. package/models/operations/updateinformationrequest.d.ts.map +1 -0
  559. package/models/operations/updateinformationrequest.js +57 -0
  560. package/models/operations/updateinformationrequest.js.map +1 -0
  561. package/package.json +4 -14
  562. package/sdk/audits.d.ts +378 -19
  563. package/sdk/audits.d.ts.map +1 -1
  564. package/sdk/audits.js +444 -25
  565. package/sdk/audits.js.map +1 -1
  566. package/sdk/sdk.d.ts +2 -2
  567. package/sdk/sdk.d.ts.map +1 -1
  568. package/sdk/sdk.js +3 -3
  569. package/sdk/sdk.js.map +1 -1
  570. package/smoke-test/src/smoke.test.ts +201 -0
  571. package/smoke-test/vitest.config.ts +11 -0
  572. package/src/funcs/auditorsCreate.ts +3 -1
  573. package/src/funcs/auditsAcceptInformationRequestEvidence.ts +195 -0
  574. package/src/funcs/auditsCreateCommentForEvidence.ts +3 -2
  575. package/src/funcs/auditsCreateCommentForInformationRequest.ts +182 -0
  576. package/src/funcs/auditsCreateCustomControl.ts +3 -2
  577. package/src/funcs/auditsCreateCustomEvidenceRequest.ts +3 -2
  578. package/src/funcs/auditsCreateInformationRequest.ts +179 -0
  579. package/src/funcs/auditsDeleteCommentForInformationRequest.ts +188 -0
  580. package/src/funcs/auditsDeleteInformationRequest.ts +185 -0
  581. package/src/funcs/auditsFlagInformationRequestEvidence.ts +195 -0
  582. package/src/funcs/auditsGetAudit.ts +172 -0
  583. package/src/funcs/auditsGetEvidenceUrls.ts +5 -2
  584. package/src/funcs/auditsGetFrameworkCodes.ts +173 -0
  585. package/src/funcs/auditsGetInformationRequest.ts +180 -0
  586. package/src/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.ts +193 -0
  587. package/src/funcs/auditsList.ts +7 -1
  588. package/src/funcs/auditsListAuditIssues.ts +191 -0
  589. package/src/funcs/auditsListAuditSnapshots.ts +191 -0
  590. package/src/funcs/auditsListComments.ts +3 -2
  591. package/src/funcs/auditsListCommentsForInformationRequest.ts +208 -0
  592. package/src/funcs/auditsListControls.ts +3 -2
  593. package/src/funcs/auditsListEvidence.ts +3 -2
  594. package/src/funcs/auditsListInformationRequestActivity.ts +204 -0
  595. package/src/funcs/auditsListInformationRequestEvidence.ts +209 -0
  596. package/src/funcs/auditsListInformationRequests.ts +197 -0
  597. package/src/funcs/auditsListInformationRequestsForControl.ts +199 -0
  598. package/src/funcs/auditsShareInformationRequestList.ts +173 -0
  599. package/src/funcs/auditsUpdateCommentForInformationRequest.ts +188 -0
  600. package/src/funcs/auditsUpdateEvidence.ts +3 -2
  601. package/src/funcs/auditsUpdateInformationRequest.ts +188 -0
  602. package/src/lib/config.ts +5 -9
  603. package/src/lib/encodings.ts +49 -7
  604. package/src/lib/files.ts +22 -0
  605. package/src/lib/matchers.ts +3 -2
  606. package/src/lib/sdks.ts +12 -13
  607. package/src/lib/security.ts +15 -4
  608. package/src/lib/url.ts +16 -14
  609. package/src/models/components/acceptinformationrequestevidenceinput.ts +46 -0
  610. package/src/models/components/addauditorinput.ts +0 -22
  611. package/src/models/components/addcommentinput.ts +0 -24
  612. package/src/models/components/addinformationrequestcommentinput.ts +67 -0
  613. package/src/models/components/audit.ts +55 -49
  614. package/src/models/components/auditevidencestate.ts +0 -4
  615. package/src/models/components/auditevidencetype.ts +0 -4
  616. package/src/models/components/auditevidenceupdateinput.ts +0 -39
  617. package/src/models/components/auditfocus.ts +0 -3
  618. package/src/models/components/auditor.ts +0 -24
  619. package/src/models/components/auditorcontrol.ts +17 -73
  620. package/src/models/components/auditorenabledstatetransition.ts +1 -5
  621. package/src/models/components/comment.ts +10 -28
  622. package/src/models/components/control.ts +16 -63
  623. package/src/models/components/controldomain.ts +1 -5
  624. package/src/models/components/controlsource.ts +0 -4
  625. package/src/models/components/createcustomcontrolinput.ts +1 -34
  626. package/src/models/components/createcustomevidencerequestinput.ts +0 -27
  627. package/src/models/components/createinformationrequestinput.ts +138 -0
  628. package/src/models/components/customevidencerequest.ts +0 -33
  629. package/src/models/components/customfield.ts +0 -30
  630. package/src/models/components/deleteinformationrequestcommentinput.ts +46 -0
  631. package/src/models/components/evidence.ts +0 -42
  632. package/src/models/components/evidencecontrol.ts +0 -20
  633. package/src/models/components/evidenceurl.ts +5 -22
  634. package/src/models/components/flaginformationrequestevidenceinput.ts +58 -0
  635. package/src/models/components/frameworkcodes.ts +40 -0
  636. package/src/models/components/frameworkid.ts +1 -4
  637. package/src/models/components/frameworksection.ts +1 -41
  638. package/src/models/components/index.ts +41 -0
  639. package/src/models/components/informationrequest.ts +295 -0
  640. package/src/models/components/informationrequestactivitylog.ts +146 -0
  641. package/src/models/components/informationrequestactivitytype.ts +22 -0
  642. package/src/models/components/informationrequestapprovalstatus.ts +37 -0
  643. package/src/models/components/informationrequestcadence.ts +27 -0
  644. package/src/models/components/informationrequestcomment.ts +105 -0
  645. package/src/models/components/informationrequestevidence.ts +100 -0
  646. package/src/models/components/informationrequestevidenceunion.ts +73 -0
  647. package/src/models/components/informationrequestsupportedevidencetype.ts +28 -0
  648. package/src/models/components/informationrequesttype.ts +40 -0
  649. package/src/models/components/issuesnapshotitem.ts +105 -0
  650. package/src/models/components/issuesnapshotmetadata.ts +50 -0
  651. package/src/models/components/issuestatustypeforsnapshot.ts +20 -0
  652. package/src/models/components/linkevidence.ts +47 -0
  653. package/src/models/components/observationevidence.ts +37 -0
  654. package/src/models/components/pageinfo.ts +0 -22
  655. package/src/models/components/paginatedissuesnapshotitemsresponse.ts +71 -0
  656. package/src/models/components/paginatedissuesnapshotmetadataresponse.ts +74 -0
  657. package/src/models/components/paginatedresponseaudit.ts +2 -50
  658. package/src/models/components/paginatedresponseauditorcontrol.ts +1 -55
  659. package/src/models/components/paginatedresponsecomment.ts +2 -56
  660. package/src/models/components/paginatedresponseevidence.ts +2 -56
  661. package/src/models/components/paginatedresponseevidenceurl.ts +2 -58
  662. package/src/models/components/paginatedresponseinformationrequest.ts +71 -0
  663. package/src/models/components/paginatedresponseinformationrequestactivitylog.ts +80 -0
  664. package/src/models/components/paginatedresponseinformationrequestcomment.ts +77 -0
  665. package/src/models/components/paginatedresponseinformationrequestevidence.ts +80 -0
  666. package/src/models/components/partialupdateinformationrequest.ts +103 -0
  667. package/src/models/components/recurrenceduration.ts +1 -0
  668. package/src/models/components/section.ts +39 -18
  669. package/src/models/components/security.ts +0 -20
  670. package/src/models/components/updateinformationrequestcommentinput.ts +56 -0
  671. package/src/models/components/uploadeddocumentevidence.ts +65 -0
  672. package/src/models/components/vantadocumentevidence.ts +145 -0
  673. package/src/models/components/vantadocumentlinkevidence.ts +50 -0
  674. package/src/models/components/vantadocumentuploadedevidence.ts +70 -0
  675. package/src/models/components/vantapolicyevidence.ts +198 -0
  676. package/src/models/components/vantatestevidence.ts +122 -0
  677. package/src/models/components/vantatestfiletype.ts +19 -0
  678. package/src/models/components/vantatestrunstatus.ts +21 -0
  679. package/src/models/components/vantatestsnapshotevidence.ts +100 -0
  680. package/src/models/components/vantatestsnapshotevidencedetail.ts +135 -0
  681. package/src/models/components/vantatestsnapshotintegration.ts +36 -0
  682. package/src/models/components/vantatestsnapshotrawtestdatarow.ts +64 -0
  683. package/src/models/operations/acceptinformationrequestevidence.ts +50 -0
  684. package/src/models/operations/createcommentforauditevidence.ts +0 -27
  685. package/src/models/operations/createcommentforinformationrequest.ts +50 -0
  686. package/src/models/operations/createcustomcontrol.ts +0 -25
  687. package/src/models/operations/createcustomevidencerequest.ts +0 -27
  688. package/src/models/operations/createinformationrequest.ts +44 -0
  689. package/src/models/operations/deletecommentforinformationrequest.ts +54 -0
  690. package/src/models/operations/deleteinformationrequest.ts +36 -0
  691. package/src/models/operations/flaginformationrequestevidence.ts +48 -0
  692. package/src/models/operations/getaudit.ts +29 -0
  693. package/src/models/operations/getframeworkcodes.ts +31 -0
  694. package/src/models/operations/getinformationrequest.ts +36 -0
  695. package/src/models/operations/getinformationrequesttestsnapshotevidencedetail.ts +41 -0
  696. package/src/models/operations/index.ts +20 -0
  697. package/src/models/operations/listauditcomments.ts +0 -25
  698. package/src/models/operations/listauditcontrols.ts +0 -22
  699. package/src/models/operations/listauditevidence.ts +0 -25
  700. package/src/models/operations/listauditevidenceurls.ts +0 -23
  701. package/src/models/operations/listauditissues.ts +58 -0
  702. package/src/models/operations/listaudits.ts +0 -25
  703. package/src/models/operations/listauditsnapshots.ts +52 -0
  704. package/src/models/operations/listcommentsforinformationrequest.ts +58 -0
  705. package/src/models/operations/listinformationrequestactivity.ts +54 -0
  706. package/src/models/operations/listinformationrequestevidence.ts +72 -0
  707. package/src/models/operations/listinformationrequests.ts +54 -0
  708. package/src/models/operations/listinformationrequestsforcontrol.ts +49 -0
  709. package/src/models/operations/shareinformationrequestlist.ts +33 -0
  710. package/src/models/operations/updateauditevidence.ts +0 -26
  711. package/src/models/operations/updatecommentforinformationrequest.ts +54 -0
  712. package/src/models/operations/updateinformationrequest.ts +47 -0
  713. package/src/sdk/audits.ts +616 -37
  714. package/src/sdk/sdk.ts +5 -5
  715. package/src/types/enums.ts +1 -21
  716. package/src/types/index.ts +2 -1
  717. package/src/types/unrecognized.ts +35 -0
  718. package/types/enums.d.ts +1 -8
  719. package/types/enums.d.ts.map +1 -1
  720. package/types/enums.js +3 -21
  721. package/types/enums.js.map +1 -1
  722. package/types/index.d.ts +2 -1
  723. package/types/index.d.ts.map +1 -1
  724. package/types/index.js +15 -0
  725. package/types/index.js.map +1 -1
  726. package/types/unrecognized.d.ts +16 -0
  727. package/types/unrecognized.d.ts.map +1 -0
  728. package/types/unrecognized.js +34 -0
  729. package/types/unrecognized.js.map +1 -0
  730. package/.devcontainer/devcontainer.json +0 -45
  731. package/bin/mcp-server.js +0 -39009
  732. package/bin/mcp-server.js.map +0 -323
  733. package/examples/package-lock.json +0 -619
  734. package/examples/package.json +0 -18
  735. package/mcp-server/build.d.mts.map +0 -1
  736. package/mcp-server/build.mjs +0 -14
  737. package/mcp-server/build.mjs.map +0 -1
  738. package/mcp-server/cli/start/command.d.ts +0 -2
  739. package/mcp-server/cli/start/command.d.ts.map +0 -1
  740. package/mcp-server/cli/start/command.js +0 -125
  741. package/mcp-server/cli/start/command.js.map +0 -1
  742. package/mcp-server/cli/start/impl.d.ts +0 -16
  743. package/mcp-server/cli/start/impl.d.ts.map +0 -1
  744. package/mcp-server/cli/start/impl.js +0 -102
  745. package/mcp-server/cli/start/impl.js.map +0 -1
  746. package/mcp-server/cli.d.ts +0 -6
  747. package/mcp-server/cli.d.ts.map +0 -1
  748. package/mcp-server/cli.js +0 -10
  749. package/mcp-server/cli.js.map +0 -1
  750. package/mcp-server/console-logger.d.ts +0 -7
  751. package/mcp-server/console-logger.d.ts.map +0 -1
  752. package/mcp-server/console-logger.js +0 -59
  753. package/mcp-server/console-logger.js.map +0 -1
  754. package/mcp-server/extensions.d.ts +0 -11
  755. package/mcp-server/extensions.d.ts.map +0 -1
  756. package/mcp-server/extensions.js +0 -6
  757. package/mcp-server/extensions.js.map +0 -1
  758. package/mcp-server/mcp-server.d.ts +0 -2
  759. package/mcp-server/mcp-server.d.ts.map +0 -1
  760. package/mcp-server/mcp-server.js +0 -29
  761. package/mcp-server/mcp-server.js.map +0 -1
  762. package/mcp-server/prompts.d.ts +0 -26
  763. package/mcp-server/prompts.d.ts.map +0 -1
  764. package/mcp-server/prompts.js +0 -51
  765. package/mcp-server/prompts.js.map +0 -1
  766. package/mcp-server/resources.d.ts +0 -32
  767. package/mcp-server/resources.d.ts.map +0 -1
  768. package/mcp-server/resources.js +0 -87
  769. package/mcp-server/resources.js.map +0 -1
  770. package/mcp-server/scopes.d.ts +0 -3
  771. package/mcp-server/scopes.d.ts.map +0 -1
  772. package/mcp-server/scopes.js +0 -8
  773. package/mcp-server/scopes.js.map +0 -1
  774. package/mcp-server/server.d.ts +0 -13
  775. package/mcp-server/server.d.ts.map +0 -1
  776. package/mcp-server/server.js +0 -52
  777. package/mcp-server/server.js.map +0 -1
  778. package/mcp-server/shared.d.ts +0 -7
  779. package/mcp-server/shared.d.ts.map +0 -1
  780. package/mcp-server/shared.js +0 -98
  781. package/mcp-server/shared.js.map +0 -1
  782. package/mcp-server/tools/auditorsCreate.d.ts +0 -8
  783. package/mcp-server/tools/auditorsCreate.d.ts.map +0 -1
  784. package/mcp-server/tools/auditorsCreate.js.map +0 -1
  785. package/mcp-server/tools/auditsCreateCommentForEvidence.d.ts +0 -8
  786. package/mcp-server/tools/auditsCreateCommentForEvidence.d.ts.map +0 -1
  787. package/mcp-server/tools/auditsCreateCommentForEvidence.js.map +0 -1
  788. package/mcp-server/tools/auditsCreateCustomControl.d.ts +0 -8
  789. package/mcp-server/tools/auditsCreateCustomControl.d.ts.map +0 -1
  790. package/mcp-server/tools/auditsCreateCustomControl.js.map +0 -1
  791. package/mcp-server/tools/auditsCreateCustomEvidenceRequest.d.ts +0 -8
  792. package/mcp-server/tools/auditsCreateCustomEvidenceRequest.d.ts.map +0 -1
  793. package/mcp-server/tools/auditsCreateCustomEvidenceRequest.js.map +0 -1
  794. package/mcp-server/tools/auditsGetEvidenceUrls.d.ts +0 -8
  795. package/mcp-server/tools/auditsGetEvidenceUrls.d.ts.map +0 -1
  796. package/mcp-server/tools/auditsGetEvidenceUrls.js +0 -65
  797. package/mcp-server/tools/auditsGetEvidenceUrls.js.map +0 -1
  798. package/mcp-server/tools/auditsList.d.ts +0 -8
  799. package/mcp-server/tools/auditsList.d.ts.map +0 -1
  800. package/mcp-server/tools/auditsList.js.map +0 -1
  801. package/mcp-server/tools/auditsListComments.d.ts +0 -8
  802. package/mcp-server/tools/auditsListComments.d.ts.map +0 -1
  803. package/mcp-server/tools/auditsListComments.js.map +0 -1
  804. package/mcp-server/tools/auditsListControls.d.ts +0 -8
  805. package/mcp-server/tools/auditsListControls.d.ts.map +0 -1
  806. package/mcp-server/tools/auditsListControls.js.map +0 -1
  807. package/mcp-server/tools/auditsListEvidence.d.ts +0 -8
  808. package/mcp-server/tools/auditsListEvidence.d.ts.map +0 -1
  809. package/mcp-server/tools/auditsListEvidence.js.map +0 -1
  810. package/mcp-server/tools/auditsUpdateEvidence.d.ts +0 -8
  811. package/mcp-server/tools/auditsUpdateEvidence.d.ts.map +0 -1
  812. package/mcp-server/tools/auditsUpdateEvidence.js.map +0 -1
  813. package/mcp-server/tools.d.ts +0 -25
  814. package/mcp-server/tools.d.ts.map +0 -1
  815. package/mcp-server/tools.js +0 -82
  816. package/mcp-server/tools.js.map +0 -1
  817. package/src/mcp-server/cli/start/command.ts +0 -93
  818. package/src/mcp-server/cli/start/impl.ts +0 -130
  819. package/src/mcp-server/cli.ts +0 -13
  820. package/src/mcp-server/console-logger.ts +0 -71
  821. package/src/mcp-server/extensions.ts +0 -17
  822. package/src/mcp-server/mcp-server.ts +0 -26
  823. package/src/mcp-server/prompts.ts +0 -117
  824. package/src/mcp-server/resources.ts +0 -172
  825. package/src/mcp-server/scopes.ts +0 -7
  826. package/src/mcp-server/server.ts +0 -79
  827. package/src/mcp-server/shared.ts +0 -74
  828. package/src/mcp-server/tools/auditorsCreate.ts +0 -37
  829. package/src/mcp-server/tools/auditsCreateCommentForEvidence.ts +0 -38
  830. package/src/mcp-server/tools/auditsCreateCustomControl.ts +0 -37
  831. package/src/mcp-server/tools/auditsCreateCustomEvidenceRequest.ts +0 -39
  832. package/src/mcp-server/tools/auditsGetEvidenceUrls.ts +0 -38
  833. package/src/mcp-server/tools/auditsList.ts +0 -37
  834. package/src/mcp-server/tools/auditsListComments.ts +0 -37
  835. package/src/mcp-server/tools/auditsListControls.ts +0 -37
  836. package/src/mcp-server/tools/auditsListEvidence.ts +0 -37
  837. package/src/mcp-server/tools/auditsUpdateEvidence.ts +0 -37
  838. package/src/mcp-server/tools.ts +0 -129
  839. package/tsconfig.json +0 -41
@@ -1,27 +1,50 @@
1
1
  # Audits
2
- (*audits*)
3
2
 
4
3
  ## Overview
5
4
 
6
5
  ### Available Operations
7
6
 
8
7
  * [list](#list) - List audits
9
- * [getEvidenceUrls](#getevidenceurls) - List audit evidence url
10
- * [listEvidence](#listevidence) - List audit evidence
8
+ * [getAudit](#getaudit) - Get audit by ID
11
9
  * [listComments](#listcomments) - List audit comments
12
10
  * [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
11
  * [createCustomControl](#createcustomcontrol) - Create a custom control for an audit
12
+ * [listInformationRequestsForControl](#listinformationrequestsforcontrol) - List information requests linked to a control within an audit
13
+ * [listEvidence](#listevidence) - List audit evidence
14
+ * [createCustomEvidenceRequest](#createcustomevidencerequest) - Create a custom evidence request for an audit
15
+ * [updateEvidence](#updateevidence) - Update audit evidence
16
+ * [createCommentForEvidence](#createcommentforevidence) - Create a comment for audit evidence
17
+ * [getEvidenceUrls](#getevidenceurls) - List audit evidence url
18
+ * [getFrameworkCodes](#getframeworkcodes) - Get framework codes for an audit
19
+ * [listInformationRequests](#listinformationrequests) - List information requests for an audit
20
+ * [createInformationRequest](#createinformationrequest) - Create a new information request
21
+ * [getInformationRequest](#getinformationrequest) - Get an information request by ID
22
+ * [updateInformationRequest](#updateinformationrequest) - Update an information request for an audit
23
+ * [deleteInformationRequest](#deleteinformationrequest) - Delete an information request for an audit
24
+ * [acceptInformationRequestEvidence](#acceptinformationrequestevidence) - Accept evidence for an information request
25
+ * [listInformationRequestActivity](#listinformationrequestactivity) - List information request activity
26
+ * [listCommentsForInformationRequest](#listcommentsforinformationrequest) - List comments for an information request
27
+ * [createCommentForInformationRequest](#createcommentforinformationrequest) - Create a comment for an information request
28
+ * [updateCommentForInformationRequest](#updatecommentforinformationrequest) - Update a comment for an information request
29
+ * [deleteCommentForInformationRequest](#deletecommentforinformationrequest) - Delete a comment for an information request
30
+ * [listInformationRequestEvidence](#listinformationrequestevidence) - List evidence for an information request
31
+ * [getInformationRequestTestSnapshotEvidenceDetail](#getinformationrequesttestsnapshotevidencedetail) - Get test snapshot detail for an evidence row
32
+ * [flagInformationRequestEvidence](#flaginformationrequestevidence) - Flag evidence for an information request
33
+ * [listAuditIssues](#listauditissues) - List snapshotted issues for an audit
34
+ * [listAuditSnapshots](#listauditsnapshots) - List snapshotted issues for an audit
35
+ * [shareInformationRequestList](#shareinformationrequestlist) - Share information request list with customer
17
36
 
18
37
  ## list
19
38
 
20
39
  Returns a paginated list of audits scoped to the audit firm.
21
40
 
41
+ To identify IRL (Information Request List) audits, check for the presence of the
42
+ `auditorRequestListMetadata` field. This field is only present for IRL-based audits
43
+ and will be `undefined` for standard audits.
44
+
22
45
  ### Example Usage
23
46
 
24
- <!-- UsageSnippet language="typescript" operationID="ListAudits" method="get" path="/audits" -->
47
+ <!-- UsageSnippet language="typescript" operationID="ListAudits" method="get" path="/audits" example="Example 1" -->
25
48
  ```typescript
26
49
  import { Vanta } from "vanta-auditor-api-sdk";
27
50
 
@@ -84,14 +107,17 @@ run();
84
107
  | --------------- | --------------- | --------------- |
85
108
  | errors.APIError | 4XX, 5XX | \*/\* |
86
109
 
87
- ## getEvidenceUrls
110
+ ## getAudit
88
111
 
89
- Returns a paginated list of evidence urls for an audit. This endpoint should be called whenever an
90
- evidence is created or has a statusUpdatedAt field that is more recent than the most recent polling event.
112
+ Returns a single audit by ID, scoped to the audit firm.
113
+
114
+ To identify IRL (Information Request List) audits, check for the presence of the
115
+ `auditorRequestListMetadata` field. This field is only present for IRL-based audits
116
+ and will be `undefined` for standard audits.
91
117
 
92
118
  ### Example Usage
93
119
 
94
- <!-- UsageSnippet language="typescript" operationID="ListAuditEvidenceUrls" method="get" path="/audits/{auditId}/evidence/{auditEvidenceId}/urls" -->
120
+ <!-- UsageSnippet language="typescript" operationID="GetAudit" method="get" path="/audits/{auditId}" example="Example 1" -->
95
121
  ```typescript
96
122
  import { Vanta } from "vanta-auditor-api-sdk";
97
123
 
@@ -100,9 +126,8 @@ const vanta = new Vanta({
100
126
  });
101
127
 
102
128
  async function run() {
103
- const result = await vanta.audits.getEvidenceUrls({
129
+ const result = await vanta.audits.getAudit({
104
130
  auditId: "<id>",
105
- auditEvidenceId: "<id>",
106
131
  });
107
132
 
108
133
  console.log(result);
@@ -117,7 +142,7 @@ The standalone function version of this method:
117
142
 
118
143
  ```typescript
119
144
  import { VantaCore } from "vanta-auditor-api-sdk/core.js";
120
- import { auditsGetEvidenceUrls } from "vanta-auditor-api-sdk/funcs/auditsGetEvidenceUrls.js";
145
+ import { auditsGetAudit } from "vanta-auditor-api-sdk/funcs/auditsGetAudit.js";
121
146
 
122
147
  // Use `VantaCore` for best tree-shaking performance.
123
148
  // You can create one instance of it to use across an application.
@@ -126,15 +151,14 @@ const vanta = new VantaCore({
126
151
  });
127
152
 
128
153
  async function run() {
129
- const res = await auditsGetEvidenceUrls(vanta, {
154
+ const res = await auditsGetAudit(vanta, {
130
155
  auditId: "<id>",
131
- auditEvidenceId: "<id>",
132
156
  });
133
157
  if (res.ok) {
134
158
  const { value: result } = res;
135
159
  console.log(result);
136
160
  } else {
137
- console.log("auditsGetEvidenceUrls failed:", res.error);
161
+ console.log("auditsGetAudit failed:", res.error);
138
162
  }
139
163
  }
140
164
 
@@ -145,14 +169,14 @@ run();
145
169
 
146
170
  | Parameter | Type | Required | Description |
147
171
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
148
- | `request` | [operations.ListAuditEvidenceUrlsRequest](../../models/operations/listauditevidenceurlsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
172
+ | `request` | [operations.GetAuditRequest](../../models/operations/getauditrequest.md) | :heavy_check_mark: | The request object to use for the request. |
149
173
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
150
174
  | `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. |
151
175
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
152
176
 
153
177
  ### Response
154
178
 
155
- **Promise\<[components.PaginatedResponseEvidenceUrl](../../models/components/paginatedresponseevidenceurl.md)\>**
179
+ **Promise\<[components.Audit](../../models/components/audit.md)\>**
156
180
 
157
181
  ### Errors
158
182
 
@@ -160,13 +184,13 @@ run();
160
184
  | --------------- | --------------- | --------------- |
161
185
  | errors.APIError | 4XX, 5XX | \*/\* |
162
186
 
163
- ## listEvidence
187
+ ## listComments
164
188
 
165
- Returns a paginated list of evidence for an audit.
189
+ Returns a paginated list of comments for an audit.
166
190
 
167
191
  ### Example Usage
168
192
 
169
- <!-- UsageSnippet language="typescript" operationID="ListAuditEvidence" method="get" path="/audits/{auditId}/evidence" -->
193
+ <!-- UsageSnippet language="typescript" operationID="ListAuditComments" method="get" path="/audits/{auditId}/comments" example="Example 1" -->
170
194
  ```typescript
171
195
  import { Vanta } from "vanta-auditor-api-sdk";
172
196
 
@@ -175,7 +199,7 @@ const vanta = new Vanta({
175
199
  });
176
200
 
177
201
  async function run() {
178
- const result = await vanta.audits.listEvidence({
202
+ const result = await vanta.audits.listComments({
179
203
  auditId: "<id>",
180
204
  });
181
205
 
@@ -191,7 +215,7 @@ The standalone function version of this method:
191
215
 
192
216
  ```typescript
193
217
  import { VantaCore } from "vanta-auditor-api-sdk/core.js";
194
- import { auditsListEvidence } from "vanta-auditor-api-sdk/funcs/auditsListEvidence.js";
218
+ import { auditsListComments } from "vanta-auditor-api-sdk/funcs/auditsListComments.js";
195
219
 
196
220
  // Use `VantaCore` for best tree-shaking performance.
197
221
  // You can create one instance of it to use across an application.
@@ -200,14 +224,14 @@ const vanta = new VantaCore({
200
224
  });
201
225
 
202
226
  async function run() {
203
- const res = await auditsListEvidence(vanta, {
227
+ const res = await auditsListComments(vanta, {
204
228
  auditId: "<id>",
205
229
  });
206
230
  if (res.ok) {
207
231
  const { value: result } = res;
208
232
  console.log(result);
209
233
  } else {
210
- console.log("auditsListEvidence failed:", res.error);
234
+ console.log("auditsListComments failed:", res.error);
211
235
  }
212
236
  }
213
237
 
@@ -218,14 +242,14 @@ run();
218
242
 
219
243
  | Parameter | Type | Required | Description |
220
244
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
221
- | `request` | [operations.ListAuditEvidenceRequest](../../models/operations/listauditevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
245
+ | `request` | [operations.ListAuditCommentsRequest](../../models/operations/listauditcommentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
222
246
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
223
247
  | `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. |
224
248
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
225
249
 
226
250
  ### Response
227
251
 
228
- **Promise\<[components.PaginatedResponseEvidence](../../models/components/paginatedresponseevidence.md)\>**
252
+ **Promise\<[components.PaginatedResponseComment](../../models/components/paginatedresponsecomment.md)\>**
229
253
 
230
254
  ### Errors
231
255
 
@@ -233,13 +257,13 @@ run();
233
257
  | --------------- | --------------- | --------------- |
234
258
  | errors.APIError | 4XX, 5XX | \*/\* |
235
259
 
236
- ## listComments
260
+ ## listControls
237
261
 
238
- Returns a paginated list of comments for an audit.
262
+ Returns a paginated list of controls for an audit.
239
263
 
240
264
  ### Example Usage
241
265
 
242
- <!-- UsageSnippet language="typescript" operationID="ListAuditComments" method="get" path="/audits/{auditId}/comments" -->
266
+ <!-- UsageSnippet language="typescript" operationID="ListAuditControls" method="get" path="/audits/{auditId}/controls" example="Example 1" -->
243
267
  ```typescript
244
268
  import { Vanta } from "vanta-auditor-api-sdk";
245
269
 
@@ -248,7 +272,7 @@ const vanta = new Vanta({
248
272
  });
249
273
 
250
274
  async function run() {
251
- const result = await vanta.audits.listComments({
275
+ const result = await vanta.audits.listControls({
252
276
  auditId: "<id>",
253
277
  });
254
278
 
@@ -264,7 +288,7 @@ The standalone function version of this method:
264
288
 
265
289
  ```typescript
266
290
  import { VantaCore } from "vanta-auditor-api-sdk/core.js";
267
- import { auditsListComments } from "vanta-auditor-api-sdk/funcs/auditsListComments.js";
291
+ import { auditsListControls } from "vanta-auditor-api-sdk/funcs/auditsListControls.js";
268
292
 
269
293
  // Use `VantaCore` for best tree-shaking performance.
270
294
  // You can create one instance of it to use across an application.
@@ -273,14 +297,14 @@ const vanta = new VantaCore({
273
297
  });
274
298
 
275
299
  async function run() {
276
- const res = await auditsListComments(vanta, {
300
+ const res = await auditsListControls(vanta, {
277
301
  auditId: "<id>",
278
302
  });
279
303
  if (res.ok) {
280
304
  const { value: result } = res;
281
305
  console.log(result);
282
306
  } else {
283
- console.log("auditsListComments failed:", res.error);
307
+ console.log("auditsListControls failed:", res.error);
284
308
  }
285
309
  }
286
310
 
@@ -291,14 +315,14 @@ run();
291
315
 
292
316
  | Parameter | Type | Required | Description |
293
317
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
294
- | `request` | [operations.ListAuditCommentsRequest](../../models/operations/listauditcommentsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
318
+ | `request` | [operations.ListAuditControlsRequest](../../models/operations/listauditcontrolsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
295
319
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
296
320
  | `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. |
297
321
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
298
322
 
299
323
  ### Response
300
324
 
301
- **Promise\<[components.PaginatedResponseComment](../../models/components/paginatedresponsecomment.md)\>**
325
+ **Promise\<[components.PaginatedResponseAuditorControl](../../models/components/paginatedresponseauditorcontrol.md)\>**
302
326
 
303
327
  ### Errors
304
328
 
@@ -306,13 +330,13 @@ run();
306
330
  | --------------- | --------------- | --------------- |
307
331
  | errors.APIError | 4XX, 5XX | \*/\* |
308
332
 
309
- ## listControls
333
+ ## createCustomControl
310
334
 
311
- Returns a paginated list of controls for an audit.
335
+ Create a custom control for an audit.
312
336
 
313
337
  ### Example Usage
314
338
 
315
- <!-- UsageSnippet language="typescript" operationID="ListAuditControls" method="get" path="/audits/{auditId}/controls" -->
339
+ <!-- UsageSnippet language="typescript" operationID="CreateCustomControl" method="post" path="/audits/{auditId}/controls/custom-controls" example="Example 1" -->
316
340
  ```typescript
317
341
  import { Vanta } from "vanta-auditor-api-sdk";
318
342
 
@@ -321,8 +345,15 @@ const vanta = new Vanta({
321
345
  });
322
346
 
323
347
  async function run() {
324
- const result = await vanta.audits.listControls({
348
+ const result = await vanta.audits.createCustomControl({
325
349
  auditId: "<id>",
350
+ createCustomControlInput: {
351
+ externalId: "<id>",
352
+ name: null,
353
+ description: "yet plus utter queasily what juvenile wound",
354
+ effectiveDate: new Date("2024-11-10T13:58:54.564Z"),
355
+ category: "CLOUD_SECURITY",
356
+ },
326
357
  });
327
358
 
328
359
  console.log(result);
@@ -337,7 +368,7 @@ The standalone function version of this method:
337
368
 
338
369
  ```typescript
339
370
  import { VantaCore } from "vanta-auditor-api-sdk/core.js";
340
- import { auditsListControls } from "vanta-auditor-api-sdk/funcs/auditsListControls.js";
371
+ import { auditsCreateCustomControl } from "vanta-auditor-api-sdk/funcs/auditsCreateCustomControl.js";
341
372
 
342
373
  // Use `VantaCore` for best tree-shaking performance.
343
374
  // You can create one instance of it to use across an application.
@@ -346,14 +377,21 @@ const vanta = new VantaCore({
346
377
  });
347
378
 
348
379
  async function run() {
349
- const res = await auditsListControls(vanta, {
380
+ const res = await auditsCreateCustomControl(vanta, {
350
381
  auditId: "<id>",
382
+ createCustomControlInput: {
383
+ externalId: "<id>",
384
+ name: null,
385
+ description: "yet plus utter queasily what juvenile wound",
386
+ effectiveDate: new Date("2024-11-10T13:58:54.564Z"),
387
+ category: "CLOUD_SECURITY",
388
+ },
351
389
  });
352
390
  if (res.ok) {
353
391
  const { value: result } = res;
354
392
  console.log(result);
355
393
  } else {
356
- console.log("auditsListControls failed:", res.error);
394
+ console.log("auditsCreateCustomControl failed:", res.error);
357
395
  }
358
396
  }
359
397
 
@@ -364,14 +402,14 @@ run();
364
402
 
365
403
  | Parameter | Type | Required | Description |
366
404
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
367
- | `request` | [operations.ListAuditControlsRequest](../../models/operations/listauditcontrolsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
405
+ | `request` | [operations.CreateCustomControlRequest](../../models/operations/createcustomcontrolrequest.md) | :heavy_check_mark: | The request object to use for the request. |
368
406
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
369
407
  | `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. |
370
408
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
371
409
 
372
410
  ### Response
373
411
 
374
- **Promise\<[components.PaginatedResponseAuditorControl](../../models/components/paginatedresponseauditorcontrol.md)\>**
412
+ **Promise\<[components.Control](../../models/components/control.md)\>**
375
413
 
376
414
  ### Errors
377
415
 
@@ -379,13 +417,29 @@ run();
379
417
  | --------------- | --------------- | --------------- |
380
418
  | errors.APIError | 4XX, 5XX | \*/\* |
381
419
 
382
- ## createCommentForEvidence
420
+ ## listInformationRequestsForControl
383
421
 
384
- Create a comment in Vanta for a piece of evidence.
422
+ Returns a paginated list of active information requests linked to a specific
423
+ control within an IRL audit. An information request is linked to a control
424
+ either via its framework codes (`criteriaIds`) or via a direct association
425
+ (`additionalControlIds`).
426
+
427
+ Soft-deleted information requests are not included in the response. To
428
+ synchronize deletions, use `GET /audits/{auditId}/information-requests`,
429
+ which supports `changedSinceDate` and includes soft-deleted records.
430
+
431
+ Returns 404 when the control is not part of the audit. Returns an empty page
432
+ when the control is part of the audit but has no active IRLs linked to it.
433
+
434
+ Pagination usage:
435
+ 1. Make initial request with desired `pageSize`
436
+ 2. Check `results.pageInfo.hasNextPage` to see if more data exists
437
+ 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request
438
+ 4. Repeat until `hasNextPage` is false
385
439
 
386
440
  ### Example Usage
387
441
 
388
- <!-- UsageSnippet language="typescript" operationID="CreateCommentForAuditEvidence" method="post" path="/audits/{auditId}/evidence/{auditEvidenceId}/comments" -->
442
+ <!-- UsageSnippet language="typescript" operationID="ListInformationRequestsForControl" method="get" path="/audits/{auditId}/controls/{controlId}/information-requests" example="Example 1" -->
389
443
  ```typescript
390
444
  import { Vanta } from "vanta-auditor-api-sdk";
391
445
 
@@ -394,14 +448,9 @@ const vanta = new Vanta({
394
448
  });
395
449
 
396
450
  async function run() {
397
- const result = await vanta.audits.createCommentForEvidence({
451
+ const result = await vanta.audits.listInformationRequestsForControl({
398
452
  auditId: "<id>",
399
- auditEvidenceId: "<id>",
400
- addCommentInput: {
401
- text: "<value>",
402
- email: "Carmen.Bogan@yahoo.com",
403
- creationDate: new Date("2024-05-28T11:04:29.369Z"),
404
- },
453
+ controlId: "<id>",
405
454
  });
406
455
 
407
456
  console.log(result);
@@ -416,7 +465,7 @@ The standalone function version of this method:
416
465
 
417
466
  ```typescript
418
467
  import { VantaCore } from "vanta-auditor-api-sdk/core.js";
419
- import { auditsCreateCommentForEvidence } from "vanta-auditor-api-sdk/funcs/auditsCreateCommentForEvidence.js";
468
+ import { auditsListInformationRequestsForControl } from "vanta-auditor-api-sdk/funcs/auditsListInformationRequestsForControl.js";
420
469
 
421
470
  // Use `VantaCore` for best tree-shaking performance.
422
471
  // You can create one instance of it to use across an application.
@@ -425,20 +474,15 @@ const vanta = new VantaCore({
425
474
  });
426
475
 
427
476
  async function run() {
428
- const res = await auditsCreateCommentForEvidence(vanta, {
477
+ const res = await auditsListInformationRequestsForControl(vanta, {
429
478
  auditId: "<id>",
430
- auditEvidenceId: "<id>",
431
- addCommentInput: {
432
- text: "<value>",
433
- email: "Carmen.Bogan@yahoo.com",
434
- creationDate: new Date("2024-05-28T11:04:29.369Z"),
435
- },
479
+ controlId: "<id>",
436
480
  });
437
481
  if (res.ok) {
438
482
  const { value: result } = res;
439
483
  console.log(result);
440
484
  } else {
441
- console.log("auditsCreateCommentForEvidence failed:", res.error);
485
+ console.log("auditsListInformationRequestsForControl failed:", res.error);
442
486
  }
443
487
  }
444
488
 
@@ -449,14 +493,14 @@ run();
449
493
 
450
494
  | Parameter | Type | Required | Description |
451
495
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
452
- | `request` | [operations.CreateCommentForAuditEvidenceRequest](../../models/operations/createcommentforauditevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
496
+ | `request` | [operations.ListInformationRequestsForControlRequest](../../models/operations/listinformationrequestsforcontrolrequest.md) | :heavy_check_mark: | The request object to use for the request. |
453
497
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
454
498
  | `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. |
455
499
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
456
500
 
457
501
  ### Response
458
502
 
459
- **Promise\<[components.Comment](../../models/components/comment.md)\>**
503
+ **Promise\<[components.PaginatedResponseInformationRequest](../../models/components/paginatedresponseinformationrequest.md)\>**
460
504
 
461
505
  ### Errors
462
506
 
@@ -464,13 +508,13 @@ run();
464
508
  | --------------- | --------------- | --------------- |
465
509
  | errors.APIError | 4XX, 5XX | \*/\* |
466
510
 
467
- ## updateEvidence
511
+ ## listEvidence
468
512
 
469
- Update audit evidence.
513
+ Returns a paginated list of evidence for an audit.
470
514
 
471
515
  ### Example Usage
472
516
 
473
- <!-- UsageSnippet language="typescript" operationID="UpdateAuditEvidence" method="patch" path="/audits/{auditId}/evidence/{auditEvidenceId}" -->
517
+ <!-- UsageSnippet language="typescript" operationID="ListAuditEvidence" method="get" path="/audits/{auditId}/evidence" example="Example 1" -->
474
518
  ```typescript
475
519
  import { Vanta } from "vanta-auditor-api-sdk";
476
520
 
@@ -479,10 +523,8 @@ const vanta = new Vanta({
479
523
  });
480
524
 
481
525
  async function run() {
482
- const result = await vanta.audits.updateEvidence({
526
+ const result = await vanta.audits.listEvidence({
483
527
  auditId: "<id>",
484
- auditEvidenceId: "<id>",
485
- auditEvidenceUpdateInput: {},
486
528
  });
487
529
 
488
530
  console.log(result);
@@ -497,7 +539,7 @@ The standalone function version of this method:
497
539
 
498
540
  ```typescript
499
541
  import { VantaCore } from "vanta-auditor-api-sdk/core.js";
500
- import { auditsUpdateEvidence } from "vanta-auditor-api-sdk/funcs/auditsUpdateEvidence.js";
542
+ import { auditsListEvidence } from "vanta-auditor-api-sdk/funcs/auditsListEvidence.js";
501
543
 
502
544
  // Use `VantaCore` for best tree-shaking performance.
503
545
  // You can create one instance of it to use across an application.
@@ -506,16 +548,14 @@ const vanta = new VantaCore({
506
548
  });
507
549
 
508
550
  async function run() {
509
- const res = await auditsUpdateEvidence(vanta, {
551
+ const res = await auditsListEvidence(vanta, {
510
552
  auditId: "<id>",
511
- auditEvidenceId: "<id>",
512
- auditEvidenceUpdateInput: {},
513
553
  });
514
554
  if (res.ok) {
515
555
  const { value: result } = res;
516
556
  console.log(result);
517
557
  } else {
518
- console.log("auditsUpdateEvidence failed:", res.error);
558
+ console.log("auditsListEvidence failed:", res.error);
519
559
  }
520
560
  }
521
561
 
@@ -526,14 +566,14 @@ run();
526
566
 
527
567
  | Parameter | Type | Required | Description |
528
568
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
529
- | `request` | [operations.UpdateAuditEvidenceRequest](../../models/operations/updateauditevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
569
+ | `request` | [operations.ListAuditEvidenceRequest](../../models/operations/listauditevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
530
570
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
531
571
  | `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. |
532
572
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
533
573
 
534
574
  ### Response
535
575
 
536
- **Promise\<[components.Evidence](../../models/components/evidence.md)\>**
576
+ **Promise\<[components.PaginatedResponseEvidence](../../models/components/paginatedresponseevidence.md)\>**
537
577
 
538
578
  ### Errors
539
579
 
@@ -547,7 +587,7 @@ Create a custom evidence request for an audit.
547
587
 
548
588
  ### Example Usage
549
589
 
550
- <!-- UsageSnippet language="typescript" operationID="CreateCustomEvidenceRequest" method="post" path="/audits/{auditId}/evidence/custom-evidence-requests" -->
590
+ <!-- UsageSnippet language="typescript" operationID="CreateCustomEvidenceRequest" method="post" path="/audits/{auditId}/evidence/custom-evidence-requests" example="Example 1" -->
551
591
  ```typescript
552
592
  import { Vanta } from "vanta-auditor-api-sdk";
553
593
 
@@ -638,13 +678,13 @@ run();
638
678
  | --------------- | --------------- | --------------- |
639
679
  | errors.APIError | 4XX, 5XX | \*/\* |
640
680
 
641
- ## createCustomControl
681
+ ## updateEvidence
642
682
 
643
- Create a custom control for an audit.
683
+ Update audit evidence.
644
684
 
645
685
  ### Example Usage
646
686
 
647
- <!-- UsageSnippet language="typescript" operationID="CreateCustomControl" method="post" path="/audits/{auditId}/controls/custom-controls" -->
687
+ <!-- UsageSnippet language="typescript" operationID="UpdateAuditEvidence" method="patch" path="/audits/{auditId}/evidence/{auditEvidenceId}" example="Example 1" -->
648
688
  ```typescript
649
689
  import { Vanta } from "vanta-auditor-api-sdk";
650
690
 
@@ -653,14 +693,90 @@ const vanta = new Vanta({
653
693
  });
654
694
 
655
695
  async function run() {
656
- const result = await vanta.audits.createCustomControl({
696
+ const result = await vanta.audits.updateEvidence({
657
697
  auditId: "<id>",
658
- createCustomControlInput: {
659
- externalId: "<id>",
660
- name: null,
661
- description: "yet plus utter queasily what juvenile wound",
662
- effectiveDate: new Date("2024-11-10T13:58:54.564Z"),
663
- category: "CLOUD_SECURITY",
698
+ auditEvidenceId: "<id>",
699
+ auditEvidenceUpdateInput: {},
700
+ });
701
+
702
+ console.log(result);
703
+ }
704
+
705
+ run();
706
+ ```
707
+
708
+ ### Standalone function
709
+
710
+ The standalone function version of this method:
711
+
712
+ ```typescript
713
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
714
+ import { auditsUpdateEvidence } from "vanta-auditor-api-sdk/funcs/auditsUpdateEvidence.js";
715
+
716
+ // Use `VantaCore` for best tree-shaking performance.
717
+ // You can create one instance of it to use across an application.
718
+ const vanta = new VantaCore({
719
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
720
+ });
721
+
722
+ async function run() {
723
+ const res = await auditsUpdateEvidence(vanta, {
724
+ auditId: "<id>",
725
+ auditEvidenceId: "<id>",
726
+ auditEvidenceUpdateInput: {},
727
+ });
728
+ if (res.ok) {
729
+ const { value: result } = res;
730
+ console.log(result);
731
+ } else {
732
+ console.log("auditsUpdateEvidence failed:", res.error);
733
+ }
734
+ }
735
+
736
+ run();
737
+ ```
738
+
739
+ ### Parameters
740
+
741
+ | Parameter | Type | Required | Description |
742
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
743
+ | `request` | [operations.UpdateAuditEvidenceRequest](../../models/operations/updateauditevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
744
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
745
+ | `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. |
746
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
747
+
748
+ ### Response
749
+
750
+ **Promise\<[components.Evidence](../../models/components/evidence.md)\>**
751
+
752
+ ### Errors
753
+
754
+ | Error Type | Status Code | Content Type |
755
+ | --------------- | --------------- | --------------- |
756
+ | errors.APIError | 4XX, 5XX | \*/\* |
757
+
758
+ ## createCommentForEvidence
759
+
760
+ Create a comment in Vanta for a piece of evidence.
761
+
762
+ ### Example Usage
763
+
764
+ <!-- UsageSnippet language="typescript" operationID="CreateCommentForAuditEvidence" method="post" path="/audits/{auditId}/evidence/{auditEvidenceId}/comments" example="Example 1" -->
765
+ ```typescript
766
+ import { Vanta } from "vanta-auditor-api-sdk";
767
+
768
+ const vanta = new Vanta({
769
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
770
+ });
771
+
772
+ async function run() {
773
+ const result = await vanta.audits.createCommentForEvidence({
774
+ auditId: "<id>",
775
+ auditEvidenceId: "<id>",
776
+ addCommentInput: {
777
+ text: "<value>",
778
+ email: "Carmen.Bogan@yahoo.com",
779
+ creationDate: new Date("2024-05-28T11:04:29.369Z"),
664
780
  },
665
781
  });
666
782
 
@@ -676,7 +792,7 @@ The standalone function version of this method:
676
792
 
677
793
  ```typescript
678
794
  import { VantaCore } from "vanta-auditor-api-sdk/core.js";
679
- import { auditsCreateCustomControl } from "vanta-auditor-api-sdk/funcs/auditsCreateCustomControl.js";
795
+ import { auditsCreateCommentForEvidence } from "vanta-auditor-api-sdk/funcs/auditsCreateCommentForEvidence.js";
680
796
 
681
797
  // Use `VantaCore` for best tree-shaking performance.
682
798
  // You can create one instance of it to use across an application.
@@ -685,21 +801,20 @@ const vanta = new VantaCore({
685
801
  });
686
802
 
687
803
  async function run() {
688
- const res = await auditsCreateCustomControl(vanta, {
804
+ const res = await auditsCreateCommentForEvidence(vanta, {
689
805
  auditId: "<id>",
690
- createCustomControlInput: {
691
- externalId: "<id>",
692
- name: null,
693
- description: "yet plus utter queasily what juvenile wound",
694
- effectiveDate: new Date("2024-11-10T13:58:54.564Z"),
695
- category: "CLOUD_SECURITY",
806
+ auditEvidenceId: "<id>",
807
+ addCommentInput: {
808
+ text: "<value>",
809
+ email: "Carmen.Bogan@yahoo.com",
810
+ creationDate: new Date("2024-05-28T11:04:29.369Z"),
696
811
  },
697
812
  });
698
813
  if (res.ok) {
699
814
  const { value: result } = res;
700
815
  console.log(result);
701
816
  } else {
702
- console.log("auditsCreateCustomControl failed:", res.error);
817
+ console.log("auditsCreateCommentForEvidence failed:", res.error);
703
818
  }
704
819
  }
705
820
 
@@ -710,14 +825,1681 @@ run();
710
825
 
711
826
  | Parameter | Type | Required | Description |
712
827
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
713
- | `request` | [operations.CreateCustomControlRequest](../../models/operations/createcustomcontrolrequest.md) | :heavy_check_mark: | The request object to use for the request. |
828
+ | `request` | [operations.CreateCommentForAuditEvidenceRequest](../../models/operations/createcommentforauditevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
714
829
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
715
830
  | `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. |
716
831
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
717
832
 
718
833
  ### Response
719
834
 
720
- **Promise\<[components.Control](../../models/components/control.md)\>**
835
+ **Promise\<[components.Comment](../../models/components/comment.md)\>**
836
+
837
+ ### Errors
838
+
839
+ | Error Type | Status Code | Content Type |
840
+ | --------------- | --------------- | --------------- |
841
+ | errors.APIError | 4XX, 5XX | \*/\* |
842
+
843
+ ## getEvidenceUrls
844
+
845
+ Returns a paginated list of evidence urls for an audit. This endpoint should be called whenever an
846
+ evidence is created or has a statusUpdatedAt field that is more recent than the most recent polling event.
847
+
848
+ Evidence must be in one of the following states to retrieve URLs: "Ready for audit", "Accepted", "Flagged", or "NA".
849
+
850
+ ### Example Usage
851
+
852
+ <!-- UsageSnippet language="typescript" operationID="ListAuditEvidenceUrls" method="get" path="/audits/{auditId}/evidence/{auditEvidenceId}/urls" example="Example 1" -->
853
+ ```typescript
854
+ import { Vanta } from "vanta-auditor-api-sdk";
855
+
856
+ const vanta = new Vanta({
857
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
858
+ });
859
+
860
+ async function run() {
861
+ const result = await vanta.audits.getEvidenceUrls({
862
+ auditId: "<id>",
863
+ auditEvidenceId: "<id>",
864
+ });
865
+
866
+ console.log(result);
867
+ }
868
+
869
+ run();
870
+ ```
871
+
872
+ ### Standalone function
873
+
874
+ The standalone function version of this method:
875
+
876
+ ```typescript
877
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
878
+ import { auditsGetEvidenceUrls } from "vanta-auditor-api-sdk/funcs/auditsGetEvidenceUrls.js";
879
+
880
+ // Use `VantaCore` for best tree-shaking performance.
881
+ // You can create one instance of it to use across an application.
882
+ const vanta = new VantaCore({
883
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
884
+ });
885
+
886
+ async function run() {
887
+ const res = await auditsGetEvidenceUrls(vanta, {
888
+ auditId: "<id>",
889
+ auditEvidenceId: "<id>",
890
+ });
891
+ if (res.ok) {
892
+ const { value: result } = res;
893
+ console.log(result);
894
+ } else {
895
+ console.log("auditsGetEvidenceUrls failed:", res.error);
896
+ }
897
+ }
898
+
899
+ run();
900
+ ```
901
+
902
+ ### Parameters
903
+
904
+ | Parameter | Type | Required | Description |
905
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
906
+ | `request` | [operations.ListAuditEvidenceUrlsRequest](../../models/operations/listauditevidenceurlsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
907
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
908
+ | `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. |
909
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
910
+
911
+ ### Response
912
+
913
+ **Promise\<[components.PaginatedResponseEvidenceUrl](../../models/components/paginatedresponseevidenceurl.md)\>**
914
+
915
+ ### Errors
916
+
917
+ | Error Type | Status Code | Content Type |
918
+ | --------------- | --------------- | --------------- |
919
+ | errors.APIError | 4XX, 5XX | \*/\* |
920
+
921
+ ## getFrameworkCodes
922
+
923
+ 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.
924
+
925
+ Use this endpoint to:
926
+ - Discover available framework codes before creating information requests
927
+ - Validate framework codes against the audit's framework
928
+ - Get context about what framework codes are available for the audit type
929
+
930
+ ### Example Usage
931
+
932
+ <!-- UsageSnippet language="typescript" operationID="GetFrameworkCodes" method="get" path="/audits/{auditId}/framework-codes" example="Example 1" -->
933
+ ```typescript
934
+ import { Vanta } from "vanta-auditor-api-sdk";
935
+
936
+ const vanta = new Vanta({
937
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
938
+ });
939
+
940
+ async function run() {
941
+ const result = await vanta.audits.getFrameworkCodes({
942
+ auditId: "<id>",
943
+ });
944
+
945
+ console.log(result);
946
+ }
947
+
948
+ run();
949
+ ```
950
+
951
+ ### Standalone function
952
+
953
+ The standalone function version of this method:
954
+
955
+ ```typescript
956
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
957
+ import { auditsGetFrameworkCodes } from "vanta-auditor-api-sdk/funcs/auditsGetFrameworkCodes.js";
958
+
959
+ // Use `VantaCore` for best tree-shaking performance.
960
+ // You can create one instance of it to use across an application.
961
+ const vanta = new VantaCore({
962
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
963
+ });
964
+
965
+ async function run() {
966
+ const res = await auditsGetFrameworkCodes(vanta, {
967
+ auditId: "<id>",
968
+ });
969
+ if (res.ok) {
970
+ const { value: result } = res;
971
+ console.log(result);
972
+ } else {
973
+ console.log("auditsGetFrameworkCodes failed:", res.error);
974
+ }
975
+ }
976
+
977
+ run();
978
+ ```
979
+
980
+ ### Parameters
981
+
982
+ | Parameter | Type | Required | Description |
983
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
984
+ | `request` | [operations.GetFrameworkCodesRequest](../../models/operations/getframeworkcodesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
985
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
986
+ | `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. |
987
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
988
+
989
+ ### Response
990
+
991
+ **Promise\<[components.FrameworkCodes](../../models/components/frameworkcodes.md)\>**
992
+
993
+ ### Errors
994
+
995
+ | Error Type | Status Code | Content Type |
996
+ | --------------- | --------------- | --------------- |
997
+ | errors.APIError | 4XX, 5XX | \*/\* |
998
+
999
+ ## listInformationRequests
1000
+
1001
+ Retrieves a paginated list of all information requests for an audit, enabling
1002
+ external audit management systems to display and track evidence requests.
1003
+
1004
+ This endpoint always includes soft-deleted records (where `deletionDate !== null`).
1005
+ Clients should check the `deletionDate` field to identify and handle deleted records
1006
+ appropriately in their systems.
1007
+
1008
+ This endpoint supports delta synchronization via the `changedSinceDate` parameter,
1009
+ allowing efficient polling for changes without retrieving the entire dataset.
1010
+
1011
+ Pagination usage:
1012
+ 1. Make initial request with desired `pageSize`
1013
+ 2. Check `results.pageInfo.hasNextPage` to see if more data exists
1014
+ 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request
1015
+ 4. Repeat until `hasNextPage` is false
1016
+
1017
+ Delta sync usage:
1018
+ 1. Store the timestamp of your last sync
1019
+ 2. Pass that timestamp as `changedSinceDate`
1020
+ 3. Only requests created, modified, or deleted since that timestamp are returned
1021
+ 4. Process updates and soft-deletes by checking the `deletionDate` field
1022
+ 5. Update your last sync timestamp to the current time
1023
+
1024
+ ### Example Usage
1025
+
1026
+ <!-- UsageSnippet language="typescript" operationID="ListInformationRequests" method="get" path="/audits/{auditId}/information-requests" example="Example 1" -->
1027
+ ```typescript
1028
+ import { Vanta } from "vanta-auditor-api-sdk";
1029
+
1030
+ const vanta = new Vanta({
1031
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1032
+ });
1033
+
1034
+ async function run() {
1035
+ const result = await vanta.audits.listInformationRequests({
1036
+ auditId: "<id>",
1037
+ });
1038
+
1039
+ console.log(result);
1040
+ }
1041
+
1042
+ run();
1043
+ ```
1044
+
1045
+ ### Standalone function
1046
+
1047
+ The standalone function version of this method:
1048
+
1049
+ ```typescript
1050
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
1051
+ import { auditsListInformationRequests } from "vanta-auditor-api-sdk/funcs/auditsListInformationRequests.js";
1052
+
1053
+ // Use `VantaCore` for best tree-shaking performance.
1054
+ // You can create one instance of it to use across an application.
1055
+ const vanta = new VantaCore({
1056
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1057
+ });
1058
+
1059
+ async function run() {
1060
+ const res = await auditsListInformationRequests(vanta, {
1061
+ auditId: "<id>",
1062
+ });
1063
+ if (res.ok) {
1064
+ const { value: result } = res;
1065
+ console.log(result);
1066
+ } else {
1067
+ console.log("auditsListInformationRequests failed:", res.error);
1068
+ }
1069
+ }
1070
+
1071
+ run();
1072
+ ```
1073
+
1074
+ ### Parameters
1075
+
1076
+ | Parameter | Type | Required | Description |
1077
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1078
+ | `request` | [operations.ListInformationRequestsRequest](../../models/operations/listinformationrequestsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1079
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1080
+ | `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. |
1081
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1082
+
1083
+ ### Response
1084
+
1085
+ **Promise\<[components.PaginatedResponseInformationRequest](../../models/components/paginatedresponseinformationrequest.md)\>**
1086
+
1087
+ ### Errors
1088
+
1089
+ | Error Type | Status Code | Content Type |
1090
+ | --------------- | --------------- | --------------- |
1091
+ | errors.APIError | 4XX, 5XX | \*/\* |
1092
+
1093
+ ## createInformationRequest
1094
+
1095
+ Creates a new information request for an audit during audit setup or as requirements evolve.
1096
+
1097
+ After creating all information requests, use POST /audits/{auditId}/share-information-request-list
1098
+ to make them visible to the customer organization. Until shared, requests remain in draft state
1099
+ visible only to auditors.
1100
+
1101
+ New requests are created in an initial state indicating evidence is needed. The status
1102
+ progresses through the workflow: initial state → awaiting review → approved or flagged.
1103
+
1104
+ ### Example Usage
1105
+
1106
+ <!-- UsageSnippet language="typescript" operationID="CreateInformationRequest" method="post" path="/audits/{auditId}/information-requests" example="Example 1" -->
1107
+ ```typescript
1108
+ import { Vanta } from "vanta-auditor-api-sdk";
1109
+
1110
+ const vanta = new Vanta({
1111
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1112
+ });
1113
+
1114
+ async function run() {
1115
+ const result = await vanta.audits.createInformationRequest({
1116
+ auditId: "<id>",
1117
+ createInformationRequestInput: {
1118
+ uniqueId: "<id>",
1119
+ title: "<value>",
1120
+ requestType: "SAMPLE",
1121
+ frameworkCodes: [],
1122
+ },
1123
+ });
1124
+
1125
+ console.log(result);
1126
+ }
1127
+
1128
+ run();
1129
+ ```
1130
+
1131
+ ### Standalone function
1132
+
1133
+ The standalone function version of this method:
1134
+
1135
+ ```typescript
1136
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
1137
+ import { auditsCreateInformationRequest } from "vanta-auditor-api-sdk/funcs/auditsCreateInformationRequest.js";
1138
+
1139
+ // Use `VantaCore` for best tree-shaking performance.
1140
+ // You can create one instance of it to use across an application.
1141
+ const vanta = new VantaCore({
1142
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1143
+ });
1144
+
1145
+ async function run() {
1146
+ const res = await auditsCreateInformationRequest(vanta, {
1147
+ auditId: "<id>",
1148
+ createInformationRequestInput: {
1149
+ uniqueId: "<id>",
1150
+ title: "<value>",
1151
+ requestType: "SAMPLE",
1152
+ frameworkCodes: [],
1153
+ },
1154
+ });
1155
+ if (res.ok) {
1156
+ const { value: result } = res;
1157
+ console.log(result);
1158
+ } else {
1159
+ console.log("auditsCreateInformationRequest failed:", res.error);
1160
+ }
1161
+ }
1162
+
1163
+ run();
1164
+ ```
1165
+
1166
+ ### Parameters
1167
+
1168
+ | Parameter | Type | Required | Description |
1169
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1170
+ | `request` | [operations.CreateInformationRequestRequest](../../models/operations/createinformationrequestrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1171
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1172
+ | `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. |
1173
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1174
+
1175
+ ### Response
1176
+
1177
+ **Promise\<[components.InformationRequest](../../models/components/informationrequest.md)\>**
1178
+
1179
+ ### Errors
1180
+
1181
+ | Error Type | Status Code | Content Type |
1182
+ | --------------- | --------------- | --------------- |
1183
+ | errors.APIError | 4XX, 5XX | \*/\* |
1184
+
1185
+ ## getInformationRequest
1186
+
1187
+ Retrieves a single information request by its ID for an audit, allowing external
1188
+ audit management systems to fetch the latest state of a specific request without
1189
+ paginating through the full list.
1190
+
1191
+ Soft-deleted records (where `deletionDate !== null`) are included in the response.
1192
+ Clients should check `deletionDate` to determine whether the request has been deleted.
1193
+
1194
+ ### Example Usage
1195
+
1196
+ <!-- UsageSnippet language="typescript" operationID="GetInformationRequest" method="get" path="/audits/{auditId}/information-requests/{requestId}" example="Example 1" -->
1197
+ ```typescript
1198
+ import { Vanta } from "vanta-auditor-api-sdk";
1199
+
1200
+ const vanta = new Vanta({
1201
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1202
+ });
1203
+
1204
+ async function run() {
1205
+ const result = await vanta.audits.getInformationRequest({
1206
+ auditId: "<id>",
1207
+ requestId: "<id>",
1208
+ });
1209
+
1210
+ console.log(result);
1211
+ }
1212
+
1213
+ run();
1214
+ ```
1215
+
1216
+ ### Standalone function
1217
+
1218
+ The standalone function version of this method:
1219
+
1220
+ ```typescript
1221
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
1222
+ import { auditsGetInformationRequest } from "vanta-auditor-api-sdk/funcs/auditsGetInformationRequest.js";
1223
+
1224
+ // Use `VantaCore` for best tree-shaking performance.
1225
+ // You can create one instance of it to use across an application.
1226
+ const vanta = new VantaCore({
1227
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1228
+ });
1229
+
1230
+ async function run() {
1231
+ const res = await auditsGetInformationRequest(vanta, {
1232
+ auditId: "<id>",
1233
+ requestId: "<id>",
1234
+ });
1235
+ if (res.ok) {
1236
+ const { value: result } = res;
1237
+ console.log(result);
1238
+ } else {
1239
+ console.log("auditsGetInformationRequest failed:", res.error);
1240
+ }
1241
+ }
1242
+
1243
+ run();
1244
+ ```
1245
+
1246
+ ### Parameters
1247
+
1248
+ | Parameter | Type | Required | Description |
1249
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1250
+ | `request` | [operations.GetInformationRequestRequest](../../models/operations/getinformationrequestrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1251
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1252
+ | `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. |
1253
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1254
+
1255
+ ### Response
1256
+
1257
+ **Promise\<[components.InformationRequest](../../models/components/informationrequest.md)\>**
1258
+
1259
+ ### Errors
1260
+
1261
+ | Error Type | Status Code | Content Type |
1262
+ | --------------- | --------------- | --------------- |
1263
+ | errors.APIError | 4XX, 5XX | \*/\* |
1264
+
1265
+ ## updateInformationRequest
1266
+
1267
+ Updates an existing information request for an audit, allowing modification of request
1268
+ details as audit requirements evolve. Supports partial updates where only specified
1269
+ fields are changed; omitted fields remain unchanged.
1270
+
1271
+ Common use cases:
1272
+ - Updating due dates as audit timelines shift
1273
+ - Refining descriptions to clarify requirements
1274
+ - Adjusting request type
1275
+
1276
+ Note: The `modificationDate` is automatically updated to the current timestamp
1277
+ when any field is changed.
1278
+
1279
+ ### Example Usage
1280
+
1281
+ <!-- UsageSnippet language="typescript" operationID="UpdateInformationRequest" method="patch" path="/audits/{auditId}/information-requests/{requestId}" example="Example 1" -->
1282
+ ```typescript
1283
+ import { Vanta } from "vanta-auditor-api-sdk";
1284
+
1285
+ const vanta = new Vanta({
1286
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1287
+ });
1288
+
1289
+ async function run() {
1290
+ const result = await vanta.audits.updateInformationRequest({
1291
+ auditId: "<id>",
1292
+ requestId: "<id>",
1293
+ partialUpdateInformationRequest: {},
1294
+ });
1295
+
1296
+ console.log(result);
1297
+ }
1298
+
1299
+ run();
1300
+ ```
1301
+
1302
+ ### Standalone function
1303
+
1304
+ The standalone function version of this method:
1305
+
1306
+ ```typescript
1307
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
1308
+ import { auditsUpdateInformationRequest } from "vanta-auditor-api-sdk/funcs/auditsUpdateInformationRequest.js";
1309
+
1310
+ // Use `VantaCore` for best tree-shaking performance.
1311
+ // You can create one instance of it to use across an application.
1312
+ const vanta = new VantaCore({
1313
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1314
+ });
1315
+
1316
+ async function run() {
1317
+ const res = await auditsUpdateInformationRequest(vanta, {
1318
+ auditId: "<id>",
1319
+ requestId: "<id>",
1320
+ partialUpdateInformationRequest: {},
1321
+ });
1322
+ if (res.ok) {
1323
+ const { value: result } = res;
1324
+ console.log(result);
1325
+ } else {
1326
+ console.log("auditsUpdateInformationRequest failed:", res.error);
1327
+ }
1328
+ }
1329
+
1330
+ run();
1331
+ ```
1332
+
1333
+ ### Parameters
1334
+
1335
+ | Parameter | Type | Required | Description |
1336
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1337
+ | `request` | [operations.UpdateInformationRequestRequest](../../models/operations/updateinformationrequestrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1338
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1339
+ | `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. |
1340
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1341
+
1342
+ ### Response
1343
+
1344
+ **Promise\<[components.InformationRequest](../../models/components/informationrequest.md)\>**
1345
+
1346
+ ### Errors
1347
+
1348
+ | Error Type | Status Code | Content Type |
1349
+ | --------------- | --------------- | --------------- |
1350
+ | errors.APIError | 4XX, 5XX | \*/\* |
1351
+
1352
+ ## deleteInformationRequest
1353
+
1354
+ Deletes an information request for an audit. This performs a soft delete, marking
1355
+ the request as deleted (setting `deletionDate`) while preserving it in the system
1356
+ for audit history and compliance tracking.
1357
+
1358
+ Soft deletion allows:
1359
+ - Maintaining complete audit trail of all requests ever created
1360
+ - Retrieving deleted requests via `changedSinceDate` for synchronization
1361
+
1362
+ After deletion:
1363
+ - The request will not appear in normal list responses (without `changedSinceDate`)
1364
+ - The request's `deletionDate` field will be populated
1365
+
1366
+ ### Example Usage
1367
+
1368
+ <!-- UsageSnippet language="typescript" operationID="DeleteInformationRequest" method="delete" path="/audits/{auditId}/information-requests/{requestId}" -->
1369
+ ```typescript
1370
+ import { Vanta } from "vanta-auditor-api-sdk";
1371
+
1372
+ const vanta = new Vanta({
1373
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1374
+ });
1375
+
1376
+ async function run() {
1377
+ await vanta.audits.deleteInformationRequest({
1378
+ auditId: "<id>",
1379
+ requestId: "<id>",
1380
+ });
1381
+
1382
+
1383
+ }
1384
+
1385
+ run();
1386
+ ```
1387
+
1388
+ ### Standalone function
1389
+
1390
+ The standalone function version of this method:
1391
+
1392
+ ```typescript
1393
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
1394
+ import { auditsDeleteInformationRequest } from "vanta-auditor-api-sdk/funcs/auditsDeleteInformationRequest.js";
1395
+
1396
+ // Use `VantaCore` for best tree-shaking performance.
1397
+ // You can create one instance of it to use across an application.
1398
+ const vanta = new VantaCore({
1399
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1400
+ });
1401
+
1402
+ async function run() {
1403
+ const res = await auditsDeleteInformationRequest(vanta, {
1404
+ auditId: "<id>",
1405
+ requestId: "<id>",
1406
+ });
1407
+ if (res.ok) {
1408
+ const { value: result } = res;
1409
+
1410
+ } else {
1411
+ console.log("auditsDeleteInformationRequest failed:", res.error);
1412
+ }
1413
+ }
1414
+
1415
+ run();
1416
+ ```
1417
+
1418
+ ### Parameters
1419
+
1420
+ | Parameter | Type | Required | Description |
1421
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1422
+ | `request` | [operations.DeleteInformationRequestRequest](../../models/operations/deleteinformationrequestrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1423
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1424
+ | `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. |
1425
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1426
+
1427
+ ### Response
1428
+
1429
+ **Promise\<void\>**
1430
+
1431
+ ### Errors
1432
+
1433
+ | Error Type | Status Code | Content Type |
1434
+ | --------------- | --------------- | --------------- |
1435
+ | errors.APIError | 4XX, 5XX | \*/\* |
1436
+
1437
+ ## acceptInformationRequestEvidence
1438
+
1439
+ Accepts evidence for an information request, confirming that all submitted evidence
1440
+ meets audit requirements. This action changes the request's approvalStatus to
1441
+ an approved state and creates an activity log entry.
1442
+
1443
+ Acceptance workflow:
1444
+ 1. Auditor reviews submitted evidence
1445
+ 2. If evidence is satisfactory, auditor calls this endpoint
1446
+ 3. Request status changes to approved state and is considered complete for this audit cycle
1447
+
1448
+ Use this endpoint when:
1449
+ - All required evidence has been submitted
1450
+ - Evidence quality meets audit standards
1451
+ - Evidence addresses all specified framework codes
1452
+ - No additional information is needed
1453
+
1454
+ ### Example Usage
1455
+
1456
+ <!-- UsageSnippet language="typescript" operationID="AcceptInformationRequestEvidence" method="post" path="/audits/{auditId}/information-requests/{requestId}/accept-evidence" example="Example 1" -->
1457
+ ```typescript
1458
+ import { Vanta } from "vanta-auditor-api-sdk";
1459
+
1460
+ const vanta = new Vanta({
1461
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1462
+ });
1463
+
1464
+ async function run() {
1465
+ const result = await vanta.audits.acceptInformationRequestEvidence({
1466
+ auditId: "<id>",
1467
+ requestId: "<id>",
1468
+ acceptInformationRequestEvidenceInput: {
1469
+ auditorEmail: "<value>",
1470
+ },
1471
+ });
1472
+
1473
+ console.log(result);
1474
+ }
1475
+
1476
+ run();
1477
+ ```
1478
+
1479
+ ### Standalone function
1480
+
1481
+ The standalone function version of this method:
1482
+
1483
+ ```typescript
1484
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
1485
+ import { auditsAcceptInformationRequestEvidence } from "vanta-auditor-api-sdk/funcs/auditsAcceptInformationRequestEvidence.js";
1486
+
1487
+ // Use `VantaCore` for best tree-shaking performance.
1488
+ // You can create one instance of it to use across an application.
1489
+ const vanta = new VantaCore({
1490
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1491
+ });
1492
+
1493
+ async function run() {
1494
+ const res = await auditsAcceptInformationRequestEvidence(vanta, {
1495
+ auditId: "<id>",
1496
+ requestId: "<id>",
1497
+ acceptInformationRequestEvidenceInput: {
1498
+ auditorEmail: "<value>",
1499
+ },
1500
+ });
1501
+ if (res.ok) {
1502
+ const { value: result } = res;
1503
+ console.log(result);
1504
+ } else {
1505
+ console.log("auditsAcceptInformationRequestEvidence failed:", res.error);
1506
+ }
1507
+ }
1508
+
1509
+ run();
1510
+ ```
1511
+
1512
+ ### Parameters
1513
+
1514
+ | Parameter | Type | Required | Description |
1515
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1516
+ | `request` | [operations.AcceptInformationRequestEvidenceRequest](../../models/operations/acceptinformationrequestevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
1517
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1518
+ | `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. |
1519
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1520
+
1521
+ ### Response
1522
+
1523
+ **Promise\<[components.InformationRequest](../../models/components/informationrequest.md)\>**
1524
+
1525
+ ### Errors
1526
+
1527
+ | Error Type | Status Code | Content Type |
1528
+ | --------------- | --------------- | --------------- |
1529
+ | errors.APIError | 4XX, 5XX | \*/\* |
1530
+
1531
+ ## listInformationRequestActivity
1532
+
1533
+ Retrieves a paginated list of activity logs for an information request, providing
1534
+ a complete audit trail of all changes and actions.
1535
+
1536
+ This endpoint supports delta synchronization via the `changedSinceDate` parameter,
1537
+ allowing efficient polling for changes without retrieving the entire dataset.
1538
+
1539
+ Pagination usage:
1540
+ 1. Make initial request with desired `pageSize`
1541
+ 2. Check `results.pageInfo.hasNextPage` to see if more data exists
1542
+ 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request
1543
+ 4. Repeat until `hasNextPage` is false
1544
+
1545
+ Delta sync usage:
1546
+ 1. Store the timestamp of your last sync
1547
+ 2. Pass that timestamp as `changedSinceDate`
1548
+ 3. Only activity created since that timestamp is returned
1549
+ 4. Process updates to track all changes to the information request
1550
+ 5. Update your last sync timestamp to the current time
1551
+
1552
+ ### Example Usage
1553
+
1554
+ <!-- UsageSnippet language="typescript" operationID="ListInformationRequestActivity" method="get" path="/audits/{auditId}/information-requests/{requestId}/activity" example="Example 1" -->
1555
+ ```typescript
1556
+ import { Vanta } from "vanta-auditor-api-sdk";
1557
+
1558
+ const vanta = new Vanta({
1559
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1560
+ });
1561
+
1562
+ async function run() {
1563
+ const result = await vanta.audits.listInformationRequestActivity({
1564
+ auditId: "<id>",
1565
+ requestId: "<id>",
1566
+ });
1567
+
1568
+ console.log(result);
1569
+ }
1570
+
1571
+ run();
1572
+ ```
1573
+
1574
+ ### Standalone function
1575
+
1576
+ The standalone function version of this method:
1577
+
1578
+ ```typescript
1579
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
1580
+ import { auditsListInformationRequestActivity } from "vanta-auditor-api-sdk/funcs/auditsListInformationRequestActivity.js";
1581
+
1582
+ // Use `VantaCore` for best tree-shaking performance.
1583
+ // You can create one instance of it to use across an application.
1584
+ const vanta = new VantaCore({
1585
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1586
+ });
1587
+
1588
+ async function run() {
1589
+ const res = await auditsListInformationRequestActivity(vanta, {
1590
+ auditId: "<id>",
1591
+ requestId: "<id>",
1592
+ });
1593
+ if (res.ok) {
1594
+ const { value: result } = res;
1595
+ console.log(result);
1596
+ } else {
1597
+ console.log("auditsListInformationRequestActivity failed:", res.error);
1598
+ }
1599
+ }
1600
+
1601
+ run();
1602
+ ```
1603
+
1604
+ ### Parameters
1605
+
1606
+ | Parameter | Type | Required | Description |
1607
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1608
+ | `request` | [operations.ListInformationRequestActivityRequest](../../models/operations/listinformationrequestactivityrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1609
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1610
+ | `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. |
1611
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1612
+
1613
+ ### Response
1614
+
1615
+ **Promise\<[components.PaginatedResponseInformationRequestActivityLog](../../models/components/paginatedresponseinformationrequestactivitylog.md)\>**
1616
+
1617
+ ### Errors
1618
+
1619
+ | Error Type | Status Code | Content Type |
1620
+ | --------------- | --------------- | --------------- |
1621
+ | errors.APIError | 4XX, 5XX | \*/\* |
1622
+
1623
+ ## listCommentsForInformationRequest
1624
+
1625
+ Retrieves a paginated list of comments for an information request, enabling
1626
+ auditors to view communication history and collaborate with customers.
1627
+
1628
+ This endpoint always includes soft-deleted records (where `deletionDate !== null`).
1629
+ Clients should check the `deletionDate` field to identify and handle deleted records
1630
+ appropriately in their systems.
1631
+
1632
+ This endpoint supports delta synchronization via the `changedSinceDate` parameter,
1633
+ allowing efficient polling for changes without retrieving the entire dataset.
1634
+
1635
+ Pagination usage:
1636
+ 1. Make initial request with desired `pageSize`
1637
+ 2. Check `results.pageInfo.hasNextPage` to see if more data exists
1638
+ 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request
1639
+ 4. Repeat until `hasNextPage` is false
1640
+
1641
+ Delta sync usage:
1642
+ 1. Store the timestamp of your last sync
1643
+ 2. Pass that timestamp as `changedSinceDate`
1644
+ 3. Only comments created, modified, or deleted since that timestamp are returned
1645
+ 4. Process updates, including soft-deletes (deletionDate !== null)
1646
+ 5. Update your last sync timestamp to the current time
1647
+
1648
+ ### Example Usage
1649
+
1650
+ <!-- UsageSnippet language="typescript" operationID="ListCommentsForInformationRequest" method="get" path="/audits/{auditId}/information-requests/{requestId}/comments" example="Example 1" -->
1651
+ ```typescript
1652
+ import { Vanta } from "vanta-auditor-api-sdk";
1653
+
1654
+ const vanta = new Vanta({
1655
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1656
+ });
1657
+
1658
+ async function run() {
1659
+ const result = await vanta.audits.listCommentsForInformationRequest({
1660
+ auditId: "<id>",
1661
+ requestId: "<id>",
1662
+ });
1663
+
1664
+ console.log(result);
1665
+ }
1666
+
1667
+ run();
1668
+ ```
1669
+
1670
+ ### Standalone function
1671
+
1672
+ The standalone function version of this method:
1673
+
1674
+ ```typescript
1675
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
1676
+ import { auditsListCommentsForInformationRequest } from "vanta-auditor-api-sdk/funcs/auditsListCommentsForInformationRequest.js";
1677
+
1678
+ // Use `VantaCore` for best tree-shaking performance.
1679
+ // You can create one instance of it to use across an application.
1680
+ const vanta = new VantaCore({
1681
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1682
+ });
1683
+
1684
+ async function run() {
1685
+ const res = await auditsListCommentsForInformationRequest(vanta, {
1686
+ auditId: "<id>",
1687
+ requestId: "<id>",
1688
+ });
1689
+ if (res.ok) {
1690
+ const { value: result } = res;
1691
+ console.log(result);
1692
+ } else {
1693
+ console.log("auditsListCommentsForInformationRequest failed:", res.error);
1694
+ }
1695
+ }
1696
+
1697
+ run();
1698
+ ```
1699
+
1700
+ ### Parameters
1701
+
1702
+ | Parameter | Type | Required | Description |
1703
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1704
+ | `request` | [operations.ListCommentsForInformationRequestRequest](../../models/operations/listcommentsforinformationrequestrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1705
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1706
+ | `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. |
1707
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1708
+
1709
+ ### Response
1710
+
1711
+ **Promise\<[components.PaginatedResponseInformationRequestComment](../../models/components/paginatedresponseinformationrequestcomment.md)\>**
1712
+
1713
+ ### Errors
1714
+
1715
+ | Error Type | Status Code | Content Type |
1716
+ | --------------- | --------------- | --------------- |
1717
+ | errors.APIError | 4XX, 5XX | \*/\* |
1718
+
1719
+ ## createCommentForInformationRequest
1720
+
1721
+ Creates a new comment for an information request. The comment author must be an auditor
1722
+ in the audit firm making the request. The comment will be associated with the information
1723
+ request and visible to all authorized users.
1724
+
1725
+ ### Example Usage
1726
+
1727
+ <!-- UsageSnippet language="typescript" operationID="CreateCommentForInformationRequest" method="post" path="/audits/{auditId}/information-requests/{requestId}/comments" example="Example 1" -->
1728
+ ```typescript
1729
+ import { Vanta } from "vanta-auditor-api-sdk";
1730
+
1731
+ const vanta = new Vanta({
1732
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1733
+ });
1734
+
1735
+ async function run() {
1736
+ const result = await vanta.audits.createCommentForInformationRequest({
1737
+ auditId: "<id>",
1738
+ requestId: "<id>",
1739
+ addInformationRequestCommentInput: {
1740
+ text: "<value>",
1741
+ email: "Daryl.Bartell38@gmail.com",
1742
+ creationDate: new Date("2024-06-25T05:04:31.105Z"),
1743
+ },
1744
+ });
1745
+
1746
+ console.log(result);
1747
+ }
1748
+
1749
+ run();
1750
+ ```
1751
+
1752
+ ### Standalone function
1753
+
1754
+ The standalone function version of this method:
1755
+
1756
+ ```typescript
1757
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
1758
+ import { auditsCreateCommentForInformationRequest } from "vanta-auditor-api-sdk/funcs/auditsCreateCommentForInformationRequest.js";
1759
+
1760
+ // Use `VantaCore` for best tree-shaking performance.
1761
+ // You can create one instance of it to use across an application.
1762
+ const vanta = new VantaCore({
1763
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1764
+ });
1765
+
1766
+ async function run() {
1767
+ const res = await auditsCreateCommentForInformationRequest(vanta, {
1768
+ auditId: "<id>",
1769
+ requestId: "<id>",
1770
+ addInformationRequestCommentInput: {
1771
+ text: "<value>",
1772
+ email: "Daryl.Bartell38@gmail.com",
1773
+ creationDate: new Date("2024-06-25T05:04:31.105Z"),
1774
+ },
1775
+ });
1776
+ if (res.ok) {
1777
+ const { value: result } = res;
1778
+ console.log(result);
1779
+ } else {
1780
+ console.log("auditsCreateCommentForInformationRequest failed:", res.error);
1781
+ }
1782
+ }
1783
+
1784
+ run();
1785
+ ```
1786
+
1787
+ ### Parameters
1788
+
1789
+ | Parameter | Type | Required | Description |
1790
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1791
+ | `request` | [operations.CreateCommentForInformationRequestRequest](../../models/operations/createcommentforinformationrequestrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1792
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1793
+ | `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. |
1794
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1795
+
1796
+ ### Response
1797
+
1798
+ **Promise\<[components.InformationRequestComment](../../models/components/informationrequestcomment.md)\>**
1799
+
1800
+ ### Errors
1801
+
1802
+ | Error Type | Status Code | Content Type |
1803
+ | --------------- | --------------- | --------------- |
1804
+ | errors.APIError | 4XX, 5XX | \*/\* |
1805
+
1806
+ ## updateCommentForInformationRequest
1807
+
1808
+ Updates an existing comment for an information request. Only the original author
1809
+ of the comment can update it. The author is identified by their email address,
1810
+ which must match the email of the user who created the comment.
1811
+
1812
+ ### Example Usage
1813
+
1814
+ <!-- UsageSnippet language="typescript" operationID="UpdateCommentForInformationRequest" method="patch" path="/audits/{auditId}/information-requests/{requestId}/comments/{commentId}" example="Example 1" -->
1815
+ ```typescript
1816
+ import { Vanta } from "vanta-auditor-api-sdk";
1817
+
1818
+ const vanta = new Vanta({
1819
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1820
+ });
1821
+
1822
+ async function run() {
1823
+ const result = await vanta.audits.updateCommentForInformationRequest({
1824
+ auditId: "<id>",
1825
+ requestId: "<id>",
1826
+ commentId: "<id>",
1827
+ updateInformationRequestCommentInput: {
1828
+ text: "<value>",
1829
+ email: "Gerald_Gusikowski36@yahoo.com",
1830
+ },
1831
+ });
1832
+
1833
+ console.log(result);
1834
+ }
1835
+
1836
+ run();
1837
+ ```
1838
+
1839
+ ### Standalone function
1840
+
1841
+ The standalone function version of this method:
1842
+
1843
+ ```typescript
1844
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
1845
+ import { auditsUpdateCommentForInformationRequest } from "vanta-auditor-api-sdk/funcs/auditsUpdateCommentForInformationRequest.js";
1846
+
1847
+ // Use `VantaCore` for best tree-shaking performance.
1848
+ // You can create one instance of it to use across an application.
1849
+ const vanta = new VantaCore({
1850
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1851
+ });
1852
+
1853
+ async function run() {
1854
+ const res = await auditsUpdateCommentForInformationRequest(vanta, {
1855
+ auditId: "<id>",
1856
+ requestId: "<id>",
1857
+ commentId: "<id>",
1858
+ updateInformationRequestCommentInput: {
1859
+ text: "<value>",
1860
+ email: "Gerald_Gusikowski36@yahoo.com",
1861
+ },
1862
+ });
1863
+ if (res.ok) {
1864
+ const { value: result } = res;
1865
+ console.log(result);
1866
+ } else {
1867
+ console.log("auditsUpdateCommentForInformationRequest failed:", res.error);
1868
+ }
1869
+ }
1870
+
1871
+ run();
1872
+ ```
1873
+
1874
+ ### Parameters
1875
+
1876
+ | Parameter | Type | Required | Description |
1877
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1878
+ | `request` | [operations.UpdateCommentForInformationRequestRequest](../../models/operations/updatecommentforinformationrequestrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1879
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1880
+ | `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. |
1881
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1882
+
1883
+ ### Response
1884
+
1885
+ **Promise\<[components.InformationRequestComment](../../models/components/informationrequestcomment.md)\>**
1886
+
1887
+ ### Errors
1888
+
1889
+ | Error Type | Status Code | Content Type |
1890
+ | --------------- | --------------- | --------------- |
1891
+ | errors.APIError | 4XX, 5XX | \*/\* |
1892
+
1893
+ ## deleteCommentForInformationRequest
1894
+
1895
+ Deletes an existing comment for an information request. Only the original author
1896
+ of the comment can delete it. The author is identified by their email address,
1897
+ which must match the email of the user who created the comment.
1898
+
1899
+ ### Example Usage
1900
+
1901
+ <!-- UsageSnippet language="typescript" operationID="DeleteCommentForInformationRequest" method="delete" path="/audits/{auditId}/information-requests/{requestId}/comments/{commentId}" -->
1902
+ ```typescript
1903
+ import { Vanta } from "vanta-auditor-api-sdk";
1904
+
1905
+ const vanta = new Vanta({
1906
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1907
+ });
1908
+
1909
+ async function run() {
1910
+ await vanta.audits.deleteCommentForInformationRequest({
1911
+ auditId: "<id>",
1912
+ requestId: "<id>",
1913
+ commentId: "<id>",
1914
+ deleteInformationRequestCommentInput: {
1915
+ email: "Ole.Adams@gmail.com",
1916
+ },
1917
+ });
1918
+
1919
+
1920
+ }
1921
+
1922
+ run();
1923
+ ```
1924
+
1925
+ ### Standalone function
1926
+
1927
+ The standalone function version of this method:
1928
+
1929
+ ```typescript
1930
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
1931
+ import { auditsDeleteCommentForInformationRequest } from "vanta-auditor-api-sdk/funcs/auditsDeleteCommentForInformationRequest.js";
1932
+
1933
+ // Use `VantaCore` for best tree-shaking performance.
1934
+ // You can create one instance of it to use across an application.
1935
+ const vanta = new VantaCore({
1936
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
1937
+ });
1938
+
1939
+ async function run() {
1940
+ const res = await auditsDeleteCommentForInformationRequest(vanta, {
1941
+ auditId: "<id>",
1942
+ requestId: "<id>",
1943
+ commentId: "<id>",
1944
+ deleteInformationRequestCommentInput: {
1945
+ email: "Ole.Adams@gmail.com",
1946
+ },
1947
+ });
1948
+ if (res.ok) {
1949
+ const { value: result } = res;
1950
+
1951
+ } else {
1952
+ console.log("auditsDeleteCommentForInformationRequest failed:", res.error);
1953
+ }
1954
+ }
1955
+
1956
+ run();
1957
+ ```
1958
+
1959
+ ### Parameters
1960
+
1961
+ | Parameter | Type | Required | Description |
1962
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1963
+ | `request` | [operations.DeleteCommentForInformationRequestRequest](../../models/operations/deletecommentforinformationrequestrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1964
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1965
+ | `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. |
1966
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1967
+
1968
+ ### Response
1969
+
1970
+ **Promise\<void\>**
1971
+
1972
+ ### Errors
1973
+
1974
+ | Error Type | Status Code | Content Type |
1975
+ | --------------- | --------------- | --------------- |
1976
+ | errors.APIError | 4XX, 5XX | \*/\* |
1977
+
1978
+ ## listInformationRequestEvidence
1979
+
1980
+ Retrieves a paginated list of all evidence attached to an information request,
1981
+ enabling auditors to review evidence submitted by customers.
1982
+
1983
+ This endpoint always includes soft-deleted records (where `deletionDate !== null`).
1984
+ Clients should check the `deletionDate` field to identify and handle deleted records
1985
+ appropriately in their systems.
1986
+
1987
+ This endpoint supports delta synchronization via the `changedSinceDate` parameter,
1988
+ allowing efficient polling for changes without retrieving the entire dataset.
1989
+
1990
+ Pagination usage:
1991
+ 1. Make initial request with desired `pageSize`
1992
+ 2. Check `results.pageInfo.hasNextPage` to see if more data exists
1993
+ 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request
1994
+ 4. Repeat until `hasNextPage` is false
1995
+
1996
+ Delta sync usage:
1997
+ 1. Store the timestamp of your last sync
1998
+ 2. Pass that timestamp as `changedSinceDate`
1999
+ 3. Only evidence created, modified, shared, or deleted since that timestamp is returned
2000
+ 4. Process updates, including soft-deletes (deletionDate !== null)
2001
+ 5. Update your last sync timestamp to the current time
2002
+
2003
+ ### Example Usage
2004
+
2005
+ <!-- UsageSnippet language="typescript" operationID="ListInformationRequestEvidence" method="get" path="/audits/{auditId}/information-requests/{requestId}/evidence" example="Example 1" -->
2006
+ ```typescript
2007
+ import { Vanta } from "vanta-auditor-api-sdk";
2008
+
2009
+ const vanta = new Vanta({
2010
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2011
+ });
2012
+
2013
+ async function run() {
2014
+ const result = await vanta.audits.listInformationRequestEvidence({
2015
+ auditId: "<id>",
2016
+ requestId: "<id>",
2017
+ });
2018
+
2019
+ console.log(result);
2020
+ }
2021
+
2022
+ run();
2023
+ ```
2024
+
2025
+ ### Standalone function
2026
+
2027
+ The standalone function version of this method:
2028
+
2029
+ ```typescript
2030
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
2031
+ import { auditsListInformationRequestEvidence } from "vanta-auditor-api-sdk/funcs/auditsListInformationRequestEvidence.js";
2032
+
2033
+ // Use `VantaCore` for best tree-shaking performance.
2034
+ // You can create one instance of it to use across an application.
2035
+ const vanta = new VantaCore({
2036
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2037
+ });
2038
+
2039
+ async function run() {
2040
+ const res = await auditsListInformationRequestEvidence(vanta, {
2041
+ auditId: "<id>",
2042
+ requestId: "<id>",
2043
+ });
2044
+ if (res.ok) {
2045
+ const { value: result } = res;
2046
+ console.log(result);
2047
+ } else {
2048
+ console.log("auditsListInformationRequestEvidence failed:", res.error);
2049
+ }
2050
+ }
2051
+
2052
+ run();
2053
+ ```
2054
+
2055
+ ### Parameters
2056
+
2057
+ | Parameter | Type | Required | Description |
2058
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2059
+ | `request` | [operations.ListInformationRequestEvidenceRequest](../../models/operations/listinformationrequestevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
2060
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2061
+ | `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. |
2062
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2063
+
2064
+ ### Response
2065
+
2066
+ **Promise\<[components.PaginatedResponseInformationRequestEvidence](../../models/components/paginatedresponseinformationrequestevidence.md)\>**
2067
+
2068
+ ### Errors
2069
+
2070
+ | Error Type | Status Code | Content Type |
2071
+ | --------------- | --------------- | --------------- |
2072
+ | errors.APIError | 4XX, 5XX | \*/\* |
2073
+
2074
+ ## getInformationRequestTestSnapshotEvidenceDetail
2075
+
2076
+ Retrieves the rich detail for a single VANTA_TEST_SNAPSHOT evidence row
2077
+ attached to an information request. The response includes test-level
2078
+ metadata (description, integrations, SLA) and the raw test data captured
2079
+ at snapshot time, presented as a uniform array of rows regardless of
2080
+ whether the snapshot is structured or unstructured.
2081
+
2082
+ For structured snapshots, the array contains one row per resource the
2083
+ test ran against; each row carries `resourceId`, `resourceType`, and the
2084
+ raw JSON for that resource.
2085
+
2086
+ For unstructured snapshots, the array contains a single row with
2087
+ `resourceId` and `resourceType` set to `null` and `rawJson` containing
2088
+ the entire test-run JSON blob.
2089
+
2090
+ ### Example Usage
2091
+
2092
+ <!-- UsageSnippet language="typescript" operationID="GetInformationRequestTestSnapshotEvidenceDetail" method="get" path="/audits/{auditId}/information-requests/{requestId}/evidence/{evidenceId}/test-snapshot" example="Example 1" -->
2093
+ ```typescript
2094
+ import { Vanta } from "vanta-auditor-api-sdk";
2095
+
2096
+ const vanta = new Vanta({
2097
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2098
+ });
2099
+
2100
+ async function run() {
2101
+ const result = await vanta.audits.getInformationRequestTestSnapshotEvidenceDetail({
2102
+ auditId: "<id>",
2103
+ requestId: "<id>",
2104
+ evidenceId: "<id>",
2105
+ });
2106
+
2107
+ console.log(result);
2108
+ }
2109
+
2110
+ run();
2111
+ ```
2112
+
2113
+ ### Standalone function
2114
+
2115
+ The standalone function version of this method:
2116
+
2117
+ ```typescript
2118
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
2119
+ import { auditsGetInformationRequestTestSnapshotEvidenceDetail } from "vanta-auditor-api-sdk/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.js";
2120
+
2121
+ // Use `VantaCore` for best tree-shaking performance.
2122
+ // You can create one instance of it to use across an application.
2123
+ const vanta = new VantaCore({
2124
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2125
+ });
2126
+
2127
+ async function run() {
2128
+ const res = await auditsGetInformationRequestTestSnapshotEvidenceDetail(vanta, {
2129
+ auditId: "<id>",
2130
+ requestId: "<id>",
2131
+ evidenceId: "<id>",
2132
+ });
2133
+ if (res.ok) {
2134
+ const { value: result } = res;
2135
+ console.log(result);
2136
+ } else {
2137
+ console.log("auditsGetInformationRequestTestSnapshotEvidenceDetail failed:", res.error);
2138
+ }
2139
+ }
2140
+
2141
+ run();
2142
+ ```
2143
+
2144
+ ### Parameters
2145
+
2146
+ | Parameter | Type | Required | Description |
2147
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2148
+ | `request` | [operations.GetInformationRequestTestSnapshotEvidenceDetailRequest](../../models/operations/getinformationrequesttestsnapshotevidencedetailrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2149
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2150
+ | `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. |
2151
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2152
+
2153
+ ### Response
2154
+
2155
+ **Promise\<[components.VantaTestSnapshotEvidenceDetail](../../models/components/vantatestsnapshotevidencedetail.md)\>**
2156
+
2157
+ ### Errors
2158
+
2159
+ | Error Type | Status Code | Content Type |
2160
+ | --------------- | --------------- | --------------- |
2161
+ | errors.APIError | 4XX, 5XX | \*/\* |
2162
+
2163
+ ## flagInformationRequestEvidence
2164
+
2165
+ Flags evidence for an information request when it doesn't meet audit requirements,
2166
+ marking issues that need to be addressed before approval. This action changes the
2167
+ request's approvalStatus to a flagged state and creates an activity log entry.
2168
+
2169
+ Flagging workflow:
2170
+ 1. Auditor reviews submitted evidence
2171
+ 2. If issues are found, auditor calls this endpoint with detailed reason
2172
+ 3. Request status changes to flagged state
2173
+ 4. Customer is notified and can see the reason in activity logs
2174
+ 5. Customer addresses issues and updates evidence
2175
+ 6. When ready, customer changes status back to awaiting review
2176
+ 7. Auditor reviews again and either flags again or accepts
2177
+
2178
+ The `reason` field should clearly explain what's missing or incorrect so the
2179
+ customer knows exactly what to fix. This reason is visible to the customer
2180
+ and appears in the activity log.
2181
+
2182
+ ### Example Usage
2183
+
2184
+ <!-- UsageSnippet language="typescript" operationID="FlagInformationRequestEvidence" method="post" path="/audits/{auditId}/information-requests/{requestId}/flag-evidence" example="Example 1" -->
2185
+ ```typescript
2186
+ import { Vanta } from "vanta-auditor-api-sdk";
2187
+
2188
+ const vanta = new Vanta({
2189
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2190
+ });
2191
+
2192
+ async function run() {
2193
+ const result = await vanta.audits.flagInformationRequestEvidence({
2194
+ auditId: "<id>",
2195
+ requestId: "<id>",
2196
+ flagInformationRequestEvidenceInput: {
2197
+ auditorEmail: "<value>",
2198
+ reason: "<value>",
2199
+ },
2200
+ });
2201
+
2202
+ console.log(result);
2203
+ }
2204
+
2205
+ run();
2206
+ ```
2207
+
2208
+ ### Standalone function
2209
+
2210
+ The standalone function version of this method:
2211
+
2212
+ ```typescript
2213
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
2214
+ import { auditsFlagInformationRequestEvidence } from "vanta-auditor-api-sdk/funcs/auditsFlagInformationRequestEvidence.js";
2215
+
2216
+ // Use `VantaCore` for best tree-shaking performance.
2217
+ // You can create one instance of it to use across an application.
2218
+ const vanta = new VantaCore({
2219
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2220
+ });
2221
+
2222
+ async function run() {
2223
+ const res = await auditsFlagInformationRequestEvidence(vanta, {
2224
+ auditId: "<id>",
2225
+ requestId: "<id>",
2226
+ flagInformationRequestEvidenceInput: {
2227
+ auditorEmail: "<value>",
2228
+ reason: "<value>",
2229
+ },
2230
+ });
2231
+ if (res.ok) {
2232
+ const { value: result } = res;
2233
+ console.log(result);
2234
+ } else {
2235
+ console.log("auditsFlagInformationRequestEvidence failed:", res.error);
2236
+ }
2237
+ }
2238
+
2239
+ run();
2240
+ ```
2241
+
2242
+ ### Parameters
2243
+
2244
+ | Parameter | Type | Required | Description |
2245
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2246
+ | `request` | [operations.FlagInformationRequestEvidenceRequest](../../models/operations/flaginformationrequestevidencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
2247
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2248
+ | `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. |
2249
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2250
+
2251
+ ### Response
2252
+
2253
+ **Promise\<[components.InformationRequest](../../models/components/informationrequest.md)\>**
2254
+
2255
+ ### Errors
2256
+
2257
+ | Error Type | Status Code | Content Type |
2258
+ | --------------- | --------------- | --------------- |
2259
+ | errors.APIError | 4XX, 5XX | \*/\* |
2260
+
2261
+ ## listAuditIssues
2262
+
2263
+ Retrieves a list of all issues that have been shared with an audit.
2264
+
2265
+ The issues returned are immutable, point-in-time snapshots; there may be duplicates of issues that have been snapshotted at different times.
2266
+ The GET /audits/{auditId}/issues/snapshots endpoint can be used to retrieve metadata about the snapshots that issues belong to.
2267
+ Issues represent compliance findings from a variety of sources that need to be tracked and remediated.
2268
+
2269
+ Supports filtering by:
2270
+ - `search`: full text search across issue title and description
2271
+ - `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.
2272
+
2273
+ Results are sorted by issue creation date in descending order (newest first).
2274
+
2275
+ Uses cursor-based pagination. To paginate:
2276
+ 1. Make initial request with desired `pageSize`
2277
+ 2. Check `results.pageInfo.hasNextPage`
2278
+ 3. Use `results.pageInfo.endCursor` as `pageCursor` for next request
2279
+
2280
+ ### Example Usage
2281
+
2282
+ <!-- UsageSnippet language="typescript" operationID="ListAuditIssues" method="get" path="/audits/{auditId}/issues/items" example="Example 1" -->
2283
+ ```typescript
2284
+ import { Vanta } from "vanta-auditor-api-sdk";
2285
+
2286
+ const vanta = new Vanta({
2287
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2288
+ });
2289
+
2290
+ async function run() {
2291
+ const result = await vanta.audits.listAuditIssues({
2292
+ auditId: "<id>",
2293
+ });
2294
+
2295
+ console.log(result);
2296
+ }
2297
+
2298
+ run();
2299
+ ```
2300
+
2301
+ ### Standalone function
2302
+
2303
+ The standalone function version of this method:
2304
+
2305
+ ```typescript
2306
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
2307
+ import { auditsListAuditIssues } from "vanta-auditor-api-sdk/funcs/auditsListAuditIssues.js";
2308
+
2309
+ // Use `VantaCore` for best tree-shaking performance.
2310
+ // You can create one instance of it to use across an application.
2311
+ const vanta = new VantaCore({
2312
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2313
+ });
2314
+
2315
+ async function run() {
2316
+ const res = await auditsListAuditIssues(vanta, {
2317
+ auditId: "<id>",
2318
+ });
2319
+ if (res.ok) {
2320
+ const { value: result } = res;
2321
+ console.log(result);
2322
+ } else {
2323
+ console.log("auditsListAuditIssues failed:", res.error);
2324
+ }
2325
+ }
2326
+
2327
+ run();
2328
+ ```
2329
+
2330
+ ### Parameters
2331
+
2332
+ | Parameter | Type | Required | Description |
2333
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2334
+ | `request` | [operations.ListAuditIssuesRequest](../../models/operations/listauditissuesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2335
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2336
+ | `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. |
2337
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2338
+
2339
+ ### Response
2340
+
2341
+ **Promise\<[components.PaginatedIssueSnapshotItemsResponse](../../models/components/paginatedissuesnapshotitemsresponse.md)\>**
2342
+
2343
+ ### Errors
2344
+
2345
+ | Error Type | Status Code | Content Type |
2346
+ | --------------- | --------------- | --------------- |
2347
+ | errors.APIError | 4XX, 5XX | \*/\* |
2348
+
2349
+ ## listAuditSnapshots
2350
+
2351
+ Retrieves a list of snapshots that have been shared with an audit.
2352
+
2353
+ The snapshots returned contain metadata about point-in-time captures of issues for an audit.
2354
+ This data can be used to filter down the list of issues to specific snapshots when querying the GET /audits/{auditId}/issues/items endpoint.
2355
+
2356
+ Supports filtering by:
2357
+ - `search`: full text search across snapshot title and description
2358
+
2359
+ Results are sorted by snapshot creation date in descending order (newest first).
2360
+
2361
+ Uses cursor-based pagination. To paginate:
2362
+ 1. Make initial request with desired `pageSize`
2363
+ 2. Check `results.pageInfo.hasNextPage`
2364
+ 3. Use `results.pageInfo.endCursor` as `pageCursor` for next request
2365
+
2366
+ ### Example Usage
2367
+
2368
+ <!-- UsageSnippet language="typescript" operationID="ListAuditSnapshots" method="get" path="/audits/{auditId}/issues/snapshots" example="Example 1" -->
2369
+ ```typescript
2370
+ import { Vanta } from "vanta-auditor-api-sdk";
2371
+
2372
+ const vanta = new Vanta({
2373
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2374
+ });
2375
+
2376
+ async function run() {
2377
+ const result = await vanta.audits.listAuditSnapshots({
2378
+ auditId: "<id>",
2379
+ });
2380
+
2381
+ console.log(result);
2382
+ }
2383
+
2384
+ run();
2385
+ ```
2386
+
2387
+ ### Standalone function
2388
+
2389
+ The standalone function version of this method:
2390
+
2391
+ ```typescript
2392
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
2393
+ import { auditsListAuditSnapshots } from "vanta-auditor-api-sdk/funcs/auditsListAuditSnapshots.js";
2394
+
2395
+ // Use `VantaCore` for best tree-shaking performance.
2396
+ // You can create one instance of it to use across an application.
2397
+ const vanta = new VantaCore({
2398
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2399
+ });
2400
+
2401
+ async function run() {
2402
+ const res = await auditsListAuditSnapshots(vanta, {
2403
+ auditId: "<id>",
2404
+ });
2405
+ if (res.ok) {
2406
+ const { value: result } = res;
2407
+ console.log(result);
2408
+ } else {
2409
+ console.log("auditsListAuditSnapshots failed:", res.error);
2410
+ }
2411
+ }
2412
+
2413
+ run();
2414
+ ```
2415
+
2416
+ ### Parameters
2417
+
2418
+ | Parameter | Type | Required | Description |
2419
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2420
+ | `request` | [operations.ListAuditSnapshotsRequest](../../models/operations/listauditsnapshotsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2421
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2422
+ | `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. |
2423
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2424
+
2425
+ ### Response
2426
+
2427
+ **Promise\<[components.PaginatedIssueSnapshotMetadataResponse](../../models/components/paginatedissuesnapshotmetadataresponse.md)\>**
2428
+
2429
+ ### Errors
2430
+
2431
+ | Error Type | Status Code | Content Type |
2432
+ | --------------- | --------------- | --------------- |
2433
+ | errors.APIError | 4XX, 5XX | \*/\* |
2434
+
2435
+ ## shareInformationRequestList
2436
+
2437
+ Shares the current information request list for an audit with the customer organization,
2438
+ making it visible in their portal. This action allows the customer to see all information
2439
+ requests that have been created for their audit. Only IRL audits are supported.
2440
+
2441
+ ### Example Usage
2442
+
2443
+ <!-- UsageSnippet language="typescript" operationID="ShareInformationRequestList" method="post" path="/audits/{auditId}/share-information-request-list" example="Example 1" -->
2444
+ ```typescript
2445
+ import { Vanta } from "vanta-auditor-api-sdk";
2446
+
2447
+ const vanta = new Vanta({
2448
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2449
+ });
2450
+
2451
+ async function run() {
2452
+ const result = await vanta.audits.shareInformationRequestList({
2453
+ auditId: "<id>",
2454
+ });
2455
+
2456
+ console.log(result);
2457
+ }
2458
+
2459
+ run();
2460
+ ```
2461
+
2462
+ ### Standalone function
2463
+
2464
+ The standalone function version of this method:
2465
+
2466
+ ```typescript
2467
+ import { VantaCore } from "vanta-auditor-api-sdk/core.js";
2468
+ import { auditsShareInformationRequestList } from "vanta-auditor-api-sdk/funcs/auditsShareInformationRequestList.js";
2469
+
2470
+ // Use `VantaCore` for best tree-shaking performance.
2471
+ // You can create one instance of it to use across an application.
2472
+ const vanta = new VantaCore({
2473
+ bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
2474
+ });
2475
+
2476
+ async function run() {
2477
+ const res = await auditsShareInformationRequestList(vanta, {
2478
+ auditId: "<id>",
2479
+ });
2480
+ if (res.ok) {
2481
+ const { value: result } = res;
2482
+ console.log(result);
2483
+ } else {
2484
+ console.log("auditsShareInformationRequestList failed:", res.error);
2485
+ }
2486
+ }
2487
+
2488
+ run();
2489
+ ```
2490
+
2491
+ ### Parameters
2492
+
2493
+ | Parameter | Type | Required | Description |
2494
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2495
+ | `request` | [operations.ShareInformationRequestListRequest](../../models/operations/shareinformationrequestlistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
2496
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2497
+ | `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. |
2498
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2499
+
2500
+ ### Response
2501
+
2502
+ **Promise\<[components.Audit](../../models/components/audit.md)\>**
721
2503
 
722
2504
  ### Errors
723
2505