11lockVersion: 2.0.0
22id: 48344567-ff5d-4d9e-92eb-dfe908f362f2
33management:
4- docChecksum: 187eab0101db7e3ea9a2435fe8db1112
4+ docChecksum: 1a2b10b336197dc97b4e05876d814f28
55 docVersion: 1.0.0
6- speakeasyVersion: 1.467.1
7- generationVersion: 2.492.3
8- releaseVersion: 0.1.1
9- configChecksum: a86342577eba207e40923ac173ece513
6+ speakeasyVersion: 1.533.0
7+ generationVersion: 2.578.0
8+ releaseVersion: 0.2.0
9+ configChecksum: 277f79a4bad56237db4b079381471e19
10+ repoURL: https://github.com/VantaInc/vanta-auditor-api-sdk-typescript.git
11+ installationURL: https://github.com/VantaInc/vanta-auditor-api-sdk-typescript
12+ published: true
1013features:
1114 typescript:
1215 additionalDependencies: 0.1.0
1316 constsAndDefaults: 0.1.11
14- core: 3.18.12
17+ core: 3.21.6
1518 defaultEnabledRetries: 0.1.0
1619 devContainers: 2.90.0
1720 enumUnions: 0.1.0
1821 envVarSecurityUsage: 0.1.2
19- globalSecurity: 2.82.12
22+ globalSecurity: 2.82.13
2023 globalSecurityCallbacks: 0.1.0
2124 globalSecurityFlattening: 0.1.0
2225 globalServerURLs: 2.82.4
26+ mcpServer: 0.9.1
2327 nameOverrides: 2.81.2
24- nullables: 0.1.0
28+ nullables: 0.1.1
2529 responseFormat: 0.2.3
2630 retries: 2.83.0
2731 sdkHooks: 0.2.0
@@ -30,10 +34,8 @@ generatedFiles:
3034 - .devcontainer/README.md
3135 - .devcontainer/devcontainer.json
3236 - .devcontainer/setup.sh
33- - .eslintrc.cjs
3437 - .gitattributes
3538 - .npmignore
36- - CONTRIBUTING.md
3739 - FUNCTIONS.md
3840 - RUNTIMES.md
3941 - USAGE.md
@@ -55,6 +57,7 @@ generatedFiles:
5557 - docs/models/components/createcustomcontrolinput.md
5658 - docs/models/components/createcustomevidencerequestinput.md
5759 - docs/models/components/customevidencerequest.md
60+ - docs/models/components/customfield.md
5861 - docs/models/components/evidence.md
5962 - docs/models/components/evidencecontrol.md
6063 - docs/models/components/evidenceurl.md
@@ -75,8 +78,10 @@ generatedFiles:
7578 - docs/models/components/recurrenceduration.md
7679 - docs/models/components/results.md
7780 - docs/models/components/role.md
81+ - docs/models/components/section.md
7882 - docs/models/components/security.md
7983 - docs/models/components/statusupdate.md
84+ - docs/models/components/value.md
8085 - docs/models/operations/createcommentforauditevidencerequest.md
8186 - docs/models/operations/createcustomcontrolrequest.md
8287 - docs/models/operations/createcustomevidencerequestrequest.md
@@ -89,6 +94,7 @@ generatedFiles:
8994 - docs/sdks/auditors/README.md
9095 - docs/sdks/audits/README.md
9196 - docs/sdks/vanta/README.md
97+ - eslint.config.mjs
9298 - jsr.json
9399 - package.json
94100 - src/core.ts
@@ -122,6 +128,29 @@ generatedFiles:
122128 - src/lib/sdks.ts
123129 - src/lib/security.ts
124130 - src/lib/url.ts
131+ - src/mcp-server/build.mts
132+ - src/mcp-server/cli.ts
133+ - src/mcp-server/cli/start/command.ts
134+ - src/mcp-server/cli/start/impl.ts
135+ - src/mcp-server/console-logger.ts
136+ - src/mcp-server/extensions.ts
137+ - src/mcp-server/mcp-server.ts
138+ - src/mcp-server/prompts.ts
139+ - src/mcp-server/resources.ts
140+ - src/mcp-server/scopes.ts
141+ - src/mcp-server/server.ts
142+ - src/mcp-server/shared.ts
143+ - src/mcp-server/tools.ts
144+ - src/mcp-server/tools/auditorsCreate.ts
145+ - src/mcp-server/tools/auditsCreateCommentForEvidence.ts
146+ - src/mcp-server/tools/auditsCreateCustomControl.ts
147+ - src/mcp-server/tools/auditsCreateCustomEvidenceRequest.ts
148+ - src/mcp-server/tools/auditsGetEvidenceUrls.ts
149+ - src/mcp-server/tools/auditsList.ts
150+ - src/mcp-server/tools/auditsListComments.ts
151+ - src/mcp-server/tools/auditsListControls.ts
152+ - src/mcp-server/tools/auditsListEvidence.ts
153+ - src/mcp-server/tools/auditsUpdateEvidence.ts
125154 - src/models/components/addauditorinput.ts
126155 - src/models/components/addcommentinput.ts
127156 - src/models/components/audit.ts
@@ -138,6 +167,7 @@ generatedFiles:
138167 - src/models/components/createcustomcontrolinput.ts
139168 - src/models/components/createcustomevidencerequestinput.ts
140169 - src/models/components/customevidencerequest.ts
170+ - src/models/components/customfield.ts
141171 - src/models/components/evidence.ts
142172 - src/models/components/evidencecontrol.ts
143173 - src/models/components/evidenceurl.ts
@@ -151,6 +181,7 @@ generatedFiles:
151181 - src/models/components/paginatedresponseevidence.ts
152182 - src/models/components/paginatedresponseevidenceurl.ts
153183 - src/models/components/recurrenceduration.ts
184+ - src/models/components/section.ts
154185 - src/models/components/security.ts
155186 - src/models/errors/apierror.ts
156187 - src/models/errors/httpclienterrors.ts
@@ -170,6 +201,7 @@ generatedFiles:
170201 - src/sdk/audits.ts
171202 - src/sdk/index.ts
172203 - src/sdk/sdk.ts
204+ - src/types/async.ts
173205 - src/types/blobs.ts
174206 - src/types/constdatetime.ts
175207 - src/types/enums.ts
@@ -182,6 +214,9 @@ generatedFiles:
182214examples:
183215 ListAudits:
184216 Example 1:
217+ parameters:
218+ query:
219+ pageSize: 10
185220 responses:
186221 "200":
187222 application/json: {"results": {"data": [{"id": "65fc81a3359c8508c9af880f", "customerOrganizationName": "corporation.com", "customerDisplayName": "Corporation Company", "customerOrganizationId": "65fc81a3359c8508c9af880f", "auditStartDate": "2024-03-07T21:25:56Z", "auditEndDate": "2024-03-14T21:25:56Z", "earlyAccessStartsDate": "2024-03-07T21:25:56Z", "framework": "SOC 2 Type II", "allowAuditorEmails": ["sam@auditor.com"], "allowAllAuditors": true, "deletionDate": "2024-03-07T21:25:56Z", "creationDate": "2024-03-07T21:25:56Z", "modificationDate": "2024-03-07T21:25:56Z", "completionDate": "2024-03-07T21:25:56Z"}], "pageInfo": {"endCursor": "YXJyYXljb25uZWN0aW9uOjE=", "hasNextPage": false, "hasPreviousPage": false, "startCursor": "YXJyYXljb25uZWN0aW9uOjA="}}}
@@ -191,7 +226,8 @@ examples:
191226 path:
192227 auditId: "<id>"
193228 auditEvidenceId: "<id>"
194- query: {}
229+ query:
230+ pageSize: 10
195231 responses:
196232 "200":
197233 application/json: {"results": {"data": [{"id": "NjVmYzgxYTMzNTljODUwOGM5YWY4ODBm", "url": "https://s3.amazonaws.com/audit-evidence/2022/audit.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=secret%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221104T140227Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=b228dbec8c1008c80c162e1210e4503dceead1e4d4751b4d9787314fd6da4d55", "filename": "example.jpg", "isDownloadable": true}], "pageInfo": {"endCursor": "YXJyYXljb25uZWN0aW9uOjE=", "hasNextPage": false, "hasPreviousPage": false, "startCursor": "YXJyYXljb25uZWN0aW9uOjA="}}}
@@ -200,7 +236,8 @@ examples:
200236 parameters:
201237 path:
202238 auditId: "<id>"
203- query: {}
239+ query:
240+ pageSize: 10
204241 responses:
205242 "200":
206243 application/json: {"results": {"data": [{"id": "65fc81a3359c8508c9af880f", "externalId": "cG9saWN5OmFjY2Vzcy1jb250cm9sLXBvbGljeQo=", "status": "Ready for audit", "name": "Access Control Policy", "deletionDate": "2024-03-07T21:25:56Z", "creationDate": "2024-03-07T21:25:56Z", "statusUpdatedDate": "2024-03-07T21:25:56Z", "testStatus": "The test was passing during this period", "evidenceType": "Policy", "evidenceId": "access-control-policy", "relatedControls": [{"name": "CRY-104", "sectionNames": ["Article 13"]}], "description": "example description of test"}], "pageInfo": {"endCursor": "YXJyYXljb25uZWN0aW9uOjE=", "hasNextPage": false, "hasPreviousPage": false, "startCursor": "YXJyYXljb25uZWN0aW9uOjA="}}}
@@ -209,36 +246,40 @@ examples:
209246 parameters:
210247 path:
211248 auditId: "<id>"
212- query: {}
249+ query:
250+ pageSize: 10
213251 responses:
214252 "200":
215- application/json: {"results": {"data": [{"id": "65fc81a3359c8508c9af880f", "auditEvidenceId": "65fc81a3359c8508c9af880f", "text": "Some comment", "creationDate": "2024-03-07T21:25:56Z", "modificationDate": "2024-03-07T21:25:56Z", "email": "vlad@vantaroo.com"}], "pageInfo": {"endCursor": "YXJyYXljb25uZWN0aW9uOjE=", "hasNextPage": false, "hasPreviousPage": false, "startCursor": "YXJyYXljb25uZWN0aW9uOjA="}}}
253+ application/json: {"results": {"data": [{"id": "65fc81a3359c8508c9af880f", "auditEvidenceId": "65fc81a3359c8508c9af880f", "text": "Some comment", "creationDate": "2024-03-07T21:25:56Z", "modificationDate": "2024-03-07T21:25:56Z", "deletionDate": "2024-03-07T21:25:56Z", " email": "vlad@vantaroo.com"}], "pageInfo": {"endCursor": "YXJyYXljb25uZWN0aW9uOjE=", "hasNextPage": false, "hasPreviousPage": false, "startCursor": "YXJyYXljb25uZWN0aW9uOjA="}}}
216254 ListAuditControls:
217255 Example 1:
218256 parameters:
219257 path:
220258 auditId: "<id>"
221- query: {}
259+ query:
260+ pageSize: 10
222261 responses:
223262 "200":
224- application/json: {"results": {"data": [{"id": "a2f7e1b9d0c3f4e5a6c7b8d9", "externalId": "CRY-104", "name": "Data encryption utilized", "description": "Access reviews are performed to ensure that access is appropriate for the user's role and responsibilities.", "source": "Vanta", "domains": ["CRYPTOGRAPHIC_PROTECTIONS"], "owner": {"id": "65e1efde08e8478f143a8ff9", "displayName": "Example Owner", "emailAddress": "example-person@email.com"}, "framework": "soc2"}], "pageInfo": {"endCursor": "YXJyYXljb25uZWN0aW9uOjE=", "hasNextPage": false, "hasPreviousPage": false, "startCursor": "YXJyYXljb25uZWN0aW9uOjA="}}}
263+ application/json: {"results": {"data": [{"id": "a2f7e1b9d0c3f4e5a6c7b8d9", "externalId": "CRY-104", "name": "Data encryption utilized", "description": "Access reviews are performed to ensure that access is appropriate for the user's role and responsibilities.", "source": "Vanta", "domains": ["CRYPTOGRAPHIC_PROTECTIONS"], "owner": {"id": "65e1efde08e8478f143a8ff9", "displayName": "Example Owner", "emailAddress": "example-person@email.com"}, "role": null, "customFields": [], " framework": "soc2", "sections": [{"name": "IPP", "framework": "HITRUST"}] }], "pageInfo": {"endCursor": "YXJyYXljb25uZWN0aW9uOjE=", "hasNextPage": false, "hasPreviousPage": false, "startCursor": "YXJyYXljb25uZWN0aW9uOjA="}}}
225264 CreateCommentForAuditEvidence:
226265 Example 1:
227266 parameters:
228267 path:
229268 auditId: "<id>"
230269 auditEvidenceId: "<id>"
231270 requestBody:
232- application/json: {"text": "<value>", "email": "Earnestine28@yahoo .com", "creationDate": "2024-11-28T04:59:12.710Z "}
271+ application/json: {"text": "<value>", "email": "Alexis74@hotmail .com", "creationDate": "2024-08-13T11:18:40.035Z "}
233272 responses:
234273 "200":
235- application/json: {"id": "65fc81a3359c8508c9af880f", "auditEvidenceId": "65fc81a3359c8508c9af880f", "text": "Some comment", "creationDate": "2024-03-07T21:25:56Z", "modificationDate": "2024-03-07T21:25:56Z", "email": "vlad@vantaroo.com"}
274+ application/json: {"id": "65fc81a3359c8508c9af880f", "auditEvidenceId": "65fc81a3359c8508c9af880f", "text": "Some comment", "creationDate": "2024-03-07T21:25:56Z", "modificationDate": "2024-03-07T21:25:56Z", "deletionDate": "2024-03-07T21:25:56Z", " email": "vlad@vantaroo.com"}
236275 UpdateAuditEvidence:
237276 Example 1:
238277 parameters:
239278 path:
240279 auditId: "<id>"
241280 auditEvidenceId: "<id>"
281+ requestBody:
282+ application/json: {}
242283 responses:
243284 "200":
244285 application/json: {"id": "65fc81a3359c8508c9af880f", "externalId": "cG9saWN5OmFjY2Vzcy1jb250cm9sLXBvbGljeQo=", "status": "Ready for audit", "name": "Access Control Policy", "deletionDate": "2024-03-07T21:25:56Z", "creationDate": "2024-03-07T21:25:56Z", "statusUpdatedDate": "2024-03-07T21:25:56Z", "testStatus": "The test was passing during this period", "evidenceType": "Policy", "evidenceId": "access-control-policy", "relatedControls": [{"name": "CRY-104", "sectionNames": ["Article 13"]}], "description": "example description of test"}
@@ -248,7 +289,7 @@ examples:
248289 path:
249290 auditId: "<id>"
250291 requestBody:
251- application/json: {"controlIds": ["<value>"], "title": "<value>", "description": "now whoa while", "cadence": "P3M", "reminderWindow": "P0D", "isRestricted": true}
292+ application/json: {"controlIds": ["<value>"], "title": "<value>", "description": "now whoa while", "cadence": "P3M", "reminderWindow": "P0D", "isRestricted": true, "auditorEmail": "<value>" }
252293 responses:
253294 "200":
254295 application/json: {"id": "65fc81a3359c8508c9af880f", "controlIds": ["1.1.2.a"], "title": "Access Control Policy", "description": "Description for Access Control Policy", "cadence": "P6M", "reminderWindow": "P6M", "isRestricted": true}
@@ -261,12 +302,13 @@ examples:
261302 application/json: {"externalId": "<id>", "name": "<value>", "description": "even keenly afore mmm yearningly ouch tough yearly intent", "effectiveDate": "2024-07-08T11:52:30.590Z", "category": "THREAT_MANAGEMENT"}
262303 responses:
263304 "201":
264- application/json: {"id": "65fc81a3359c8508c9af880f ", "externalId": "<id> ", "name": "<value> ", "description": "Description for Access Control Policy ", "source": "Vanta", "domains": ["<value> "], "owner": {"id": "<id> ", "displayName": "Jamey_Swaniawski ", "emailAddress": "Sibyl.Connelly@yahoo .com"}}
305+ application/json: {"id": "a2f7e1b9d0c3f4e5a6c7b8d9 ", "externalId": "CRY-104 ", "name": "Data encryption utilized ", "description": "Access reviews are performed to ensure that access is appropriate for the user's role and responsibilities. ", "source": "Vanta", "domains": ["CRYPTOGRAPHIC_PROTECTIONS "], "owner": {"id": "65e1efde08e8478f143a8ff9 ", "displayName": "Example Owner ", "emailAddress": "example-person@email .com"}, "role": "CONTROLLER", "customFields": [{"label": "Additional context", "value": "This control is critical for GDPR compliance"}] }
265306 CreateAuditor:
266307 Example 1:
267308 requestBody:
268- application/json: {"email": "Cooper59@hotmail .com", "givenName": "<value>", "familyName": "<value>"}
309+ application/json: {"email": "Loyal79@yahoo .com", "givenName": "<value>", "familyName": "<value>"}
269310 responses:
270311 "200":
271312 application/json: {"id": "65fc81a3359c8508c9af880f", "organizationId": "8c9af880f1a335965fc850c8", "email": "testauditor@audit.com", "givenName": "Sam", "familyName": "Auditor"}
313+ examplesVersion: 1.0.1
272314generatedTests: {}
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
![speakeasy-github[bot]](https://avatars.githubusercontent.com/in/308252?v=4&size=40){kind=avatar}
0 commit comments