Skip to content

Commit 417bf8b

Browse files
github-actions[bot]speakeasybotspeakeasy-github[bot]
authored
chore: 🐝 Update SDK - Generate 0.3.0 (#11)
> [!IMPORTANT] > Linting report available at: <https://app.speakeasy.com/org/vanta/vanta/linting-report/c53378744fdbdf3e18a9d052ba18883f> # SDK update Based on: - OpenAPI Doc - Speakeasy CLI 1.583.0 (2.658.3) https://github.com/speakeasy-api/speakeasy ## Versioning Version Bump Type: [minor] - 🤖 (automated) ## TYPESCRIPT CHANGELOG ## sdkHooks: 0.3.0 - 2025-05-21 ### 🐝 New Features - add support for accessing sdk configuration in hooks *(commit by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))* ## mcpServer: 0.9.3 - 2025-07-01 ### 🐛 Bug Fixes - Prevent stricli 1.2.0 error when not using MCP scopes *(commit by [@bflad](https://github.com/bflad))* ## mcpServer: 0.9.2 - 2025-04-17 ### 🐛 Bug Fixes - Pin @modelcontextprotocol/sdk to 1.9.0 to prevent breaking changes in 1.10.0 *(commit by [@bflad](https://github.com/bflad))* ## core: 3.21.14 - 2025-07-09 ### 🐛 Bug Fixes - [force-gen] limit zod version to ^3 *(commit by [@walker-tx](https://github.com/walker-tx))* ## core: 3.21.13 - 2025-07-03 ### 🐛 Bug Fixes - pin @types/bun version to last compatible release *(commit by [@vishalg0wda](https://github.com/vishalg0wda))* ## core: 3.21.12 - 2025-07-03 ### 🐛 Bug Fixes - fixed generation of example call signatures when skipping optional parameters *(commit by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))* ## core: 3.21.11 - 2025-06-09 ### 🐛 Bug Fixes - add support for arrays of files in multipart forms *(commit by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))* ## core: 3.21.10 - 2025-05-30 ### 🐛 Bug Fixes - re-export HTTPClient from root index.ts *(commit by [@disintegrator](https://github.com/disintegrator))* ## core: 3.21.9 - 2025-05-19 ### 🐛 Bug Fixes - Prevent errors with Zod 3.25+ and commonjs module config *(commit by [@bflad](https://github.com/bflad))* ## core: 3.21.8 - 2025-05-07 ### 🐛 Bug Fixes - fixed stability of generated examples using operation and field seeds, including fixes to union examples *(commit by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))* ## core: 3.21.7 - 2025-04-30 ### 🐛 Bug Fixes - allow intentional string escaping without lint errors *(commit by [@vishalg0wda](https://github.com/vishalg0wda))* ## globalServerURLs: 2.82.5 - 2025-05-09 ### 🐛 Bug Fixes - fixed issue with cached templated server url *(commit by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))* ## unions: 2.85.11 - 2025-06-19 ### 🐛 Bug Fixes - regression related to union discriminator mapping *(commit by [@mfbx9da4](https://github.com/mfbx9da4))* ## unions: 2.85.10 - 2025-06-13 ### 🐛 Bug Fixes - implement union type sorting by required fields count *(commit by [@TristanSpeakEasy](https://github.com/tristanspeakeasy))* ## unions: 2.85.9 - 2025-06-05 ### 🐛 Bug Fixes - Handle unions for multipart/form-data request body *(commit by [@kanwardeep](https://github.com/Kanwardeep))* ## constsAndDefaults: 0.1.12 - 2025-06-11 ### 🐛 Bug Fixes - fix to const handling *(commit by [@mfbx9da4](https://github.com/mfbx9da4))* --------- Co-authored-by: speakeasybot <[email protected]> Co-authored-by: speakeasy-github[bot] <128539517+speakeasy-github[bot]@users.noreply.github.com>
1 parent dd2358d commit 417bf8b

File tree

77 files changed

+1634
-749
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+1634
-749
lines changed

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
/examples/node_modules
2+
.DS_Store
3+
**/.speakeasy/temp/
4+
**/.speakeasy/logs/
5+
.DS_Store
6+
.env
7+
.env.local
8+
.env.*.local
19
/mcp-server
210
/bin
311
/.eslintcache

.speakeasy/gen.lock

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
11
lockVersion: 2.0.0
22
id: 48344567-ff5d-4d9e-92eb-dfe908f362f2
33
management:
4-
docChecksum: 1a2b10b336197dc97b4e05876d814f28
4+
docChecksum: 32687d9ba29da014326cc097fdfff59d
55
docVersion: 1.0.0
6-
speakeasyVersion: 1.533.0
7-
generationVersion: 2.578.0
8-
releaseVersion: 0.2.0
9-
configChecksum: 277f79a4bad56237db4b079381471e19
6+
speakeasyVersion: 1.583.0
7+
generationVersion: 2.658.3
8+
releaseVersion: 0.3.0
9+
configChecksum: b91da7768fbb2f57f5060768e05e54e1
1010
repoURL: https://github.com/VantaInc/vanta-auditor-api-sdk-typescript.git
1111
installationURL: https://github.com/VantaInc/vanta-auditor-api-sdk-typescript
1212
published: true
1313
features:
1414
typescript:
1515
additionalDependencies: 0.1.0
16-
constsAndDefaults: 0.1.11
17-
core: 3.21.6
16+
constsAndDefaults: 0.1.12
17+
core: 3.21.14
1818
defaultEnabledRetries: 0.1.0
1919
devContainers: 2.90.0
2020
enumUnions: 0.1.0
2121
envVarSecurityUsage: 0.1.2
2222
globalSecurity: 2.82.13
2323
globalSecurityCallbacks: 0.1.0
2424
globalSecurityFlattening: 0.1.0
25-
globalServerURLs: 2.82.4
26-
mcpServer: 0.9.1
25+
globalServerURLs: 2.82.5
26+
mcpServer: 0.9.3
2727
nameOverrides: 2.81.2
2828
nullables: 0.1.1
2929
responseFormat: 0.2.3
3030
retries: 2.83.0
31-
sdkHooks: 0.2.0
32-
unions: 2.85.8
31+
sdkHooks: 0.3.0
32+
unions: 2.85.11
3333
generatedFiles:
3434
- .devcontainer/README.md
3535
- .devcontainer/devcontainer.json
@@ -46,6 +46,7 @@ generatedFiles:
4646
- docs/models/components/auditevidencestate.md
4747
- docs/models/components/auditevidencetype.md
4848
- docs/models/components/auditevidenceupdateinput.md
49+
- docs/models/components/auditfocus.md
4950
- docs/models/components/auditor.md
5051
- docs/models/components/auditorcontrol.md
5152
- docs/models/components/auditorenabledstatetransition.md
@@ -95,6 +96,10 @@ generatedFiles:
9596
- docs/sdks/audits/README.md
9697
- docs/sdks/vanta/README.md
9798
- eslint.config.mjs
99+
- examples/.env.template
100+
- examples/README.md
101+
- examples/auditsList.example.ts
102+
- examples/package.json
98103
- jsr.json
99104
- package.json
100105
- src/core.ts
@@ -157,6 +162,7 @@ generatedFiles:
157162
- src/models/components/auditevidencestate.ts
158163
- src/models/components/auditevidencetype.ts
159164
- src/models/components/auditevidenceupdateinput.ts
165+
- src/models/components/auditfocus.ts
160166
- src/models/components/auditor.ts
161167
- src/models/components/auditorcontrol.ts
162168
- src/models/components/auditorenabledstatetransition.ts
@@ -186,7 +192,9 @@ generatedFiles:
186192
- src/models/errors/apierror.ts
187193
- src/models/errors/httpclienterrors.ts
188194
- src/models/errors/index.ts
195+
- src/models/errors/responsevalidationerror.ts
189196
- src/models/errors/sdkvalidationerror.ts
197+
- src/models/errors/vantaerror.ts
190198
- src/models/operations/createcommentforauditevidence.ts
191199
- src/models/operations/createcustomcontrol.ts
192200
- src/models/operations/createcustomevidencerequest.ts
@@ -219,7 +227,7 @@ examples:
219227
pageSize: 10
220228
responses:
221229
"200":
222-
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": ["[email protected]"], "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="}}}
230+
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", "earlyAccessStartsAt": "2024-03-07T21:25:56Z", "framework": "SOC 2 Type II", "allowAuditorEmails": ["[email protected]"], "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", "auditFocus": "EXTERNAL"}], "pageInfo": {"endCursor": "YXJyYXljb25uZWN0aW9uOjE=", "hasNextPage": false, "hasPreviousPage": false, "startCursor": "YXJyYXljb25uZWN0aW9uOjA="}}}
223231
ListAuditEvidenceUrls:
224232
Example 1:
225233
parameters:
@@ -268,7 +276,7 @@ examples:
268276
auditId: "<id>"
269277
auditEvidenceId: "<id>"
270278
requestBody:
271-
application/json: {"text": "<value>", "email": "Alexis74@hotmail.com", "creationDate": "2024-08-13T11:18:40.035Z"}
279+
application/json: {"text": "<value>", "email": "Carmen.Bogan@yahoo.com", "creationDate": "2024-05-28T11:04:29.369Z"}
272280
responses:
273281
"200":
274282
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": "[email protected]"}
@@ -289,7 +297,7 @@ examples:
289297
path:
290298
auditId: "<id>"
291299
requestBody:
292-
application/json: {"controlIds": ["<value>"], "title": "<value>", "description": "now whoa while", "cadence": "P3M", "reminderWindow": "P0D", "isRestricted": true, "auditorEmail": "<value>"}
300+
application/json: {"controlIds": ["<value 1>", "<value 2>"], "title": "<value>", "description": "pure bludgeon deliberately question although", "cadence": "P1D", "reminderWindow": "P0D", "isRestricted": false, "auditorEmail": "<value>"}
293301
responses:
294302
"200":
295303
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}
@@ -299,16 +307,16 @@ examples:
299307
path:
300308
auditId: "<id>"
301309
requestBody:
302-
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"}
310+
application/json: {"externalId": "<id>", "name": null, "description": "yet plus utter queasily what juvenile wound", "effectiveDate": "2024-11-10T13:58:54.564Z", "category": "CLOUD_SECURITY"}
303311
responses:
304312
"201":
305313
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": "[email protected]"}, "role": "CONTROLLER", "customFields": [{"label": "Additional context", "value": "This control is critical for GDPR compliance"}]}
306314
CreateAuditor:
307315
Example 1:
308316
requestBody:
309-
application/json: {"email": "Loyal79@yahoo.com", "givenName": "<value>", "familyName": "<value>"}
317+
application/json: {"email": "Genesis_Kunze87@yahoo.com", "givenName": "<value>", "familyName": "<value>"}
310318
responses:
311319
"200":
312320
application/json: {"id": "65fc81a3359c8508c9af880f", "organizationId": "8c9af880f1a335965fc850c8", "email": "[email protected]", "givenName": "Sam", "familyName": "Auditor"}
313-
examplesVersion: 1.0.1
321+
examplesVersion: 1.0.2
314322
generatedTests: {}

.speakeasy/gen.yaml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,33 @@ generation:
77
maintainOpenAPIOrder: true
88
usageSnippets:
99
optionalPropertyRendering: withExample
10+
sdkInitStyle: constructor
1011
useClassNamesForArrayFields: true
1112
fixes:
1213
nameResolutionDec2023: true
1314
nameResolutionFeb2025: false
1415
parameterOrderingFeb2024: true
1516
requestResponseComponentNamesFeb2024: true
1617
securityFeb2025: false
18+
sharedErrorComponentsApr2025: false
1719
auth:
1820
oAuth2ClientCredentialsEnabled: true
1921
oAuth2PasswordEnabled: true
22+
tests:
23+
generateTests: true
24+
generateNewTests: false
25+
skipResponseBodyAssertions: false
2026
typescript:
21-
version: 0.2.0
27+
version: 0.3.0
2228
additionalDependencies:
2329
dependencies: {}
2430
devDependencies: {}
2531
peerDependencies: {}
2632
additionalPackageJSON: {}
2733
author: Speakeasy
34+
baseErrorName: VantaError
2835
clientServerStatusCodesAsErrors: true
36+
constFieldsAlwaysOptional: true
2937
defaultErrorName: APIError
3038
enableCustomCodeRegions: false
3139
enableMCPServer: true
@@ -34,6 +42,7 @@ typescript:
3442
envVarPrefix: VANTA
3543
flattenGlobalSecurity: true
3644
flatteningOrder: parameters-first
45+
generateExamples: true
3746
imports:
3847
option: openapi
3948
paths:

.speakeasy/workflow.lock

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.533.0
1+
speakeasyVersion: 1.583.0
22
sources:
33
Conduct an audit:
44
sourceNamespace: conduct-an-audit
5-
sourceRevisionDigest: sha256:ec0e5f7188da957554a2175874ee7a7c671251cddb84a0911cf73f1e6b4ae612
6-
sourceBlobDigest: sha256:bbe79169dea0b06f442a5b981fda5eb09f04b5ea369ef9832e48e6feabdccc08
5+
sourceRevisionDigest: sha256:234b914b23cf5d74d33cd7077560a45c8cba13a211f3bd8344041648d8733c2d
6+
sourceBlobDigest: sha256:8fefc2fa168b537a6f137983f6366a1d8abe9ea0a01bc6d108c601431b922a5b
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1744653558
9+
- speakeasy-sdk-regen-1752107287
1010
- 1.0.0
1111
targets:
1212
vanta:
1313
source: Conduct an audit
1414
sourceNamespace: conduct-an-audit
15-
sourceRevisionDigest: sha256:ec0e5f7188da957554a2175874ee7a7c671251cddb84a0911cf73f1e6b4ae612
16-
sourceBlobDigest: sha256:bbe79169dea0b06f442a5b981fda5eb09f04b5ea369ef9832e48e6feabdccc08
15+
sourceRevisionDigest: sha256:234b914b23cf5d74d33cd7077560a45c8cba13a211f3bd8344041648d8733c2d
16+
sourceBlobDigest: sha256:8fefc2fa168b537a6f137983f6366a1d8abe9ea0a01bc6d108c601431b922a5b
1717
codeSamplesNamespace: conduct-an-audit-typescript-code-samples
18-
codeSamplesRevisionDigest: sha256:6e53c3e5e71c376fb2f45ab25697dad7892b83b774caaaabffbc63d3df63c95e
18+
codeSamplesRevisionDigest: sha256:ed572847c06a09b0e1f3d5e784af0b3a9ca9deebeb78e39163dfd13116ec76a1
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest

FUNCTIONS.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ specific category of applications.
2121
```typescript
2222
import { VantaCore } from "vanta-auditor-api-sdk/core.js";
2323
import { auditsList } from "vanta-auditor-api-sdk/funcs/auditsList.js";
24-
import { SDKValidationError } from "vanta-auditor-api-sdk/models/errors/sdkvalidationerror.js";
2524

2625
// Use `VantaCore` for best tree-shaking performance.
2726
// You can create one instance of it to use across an application.
@@ -31,28 +30,12 @@ const vanta = new VantaCore({
3130

3231
async function run() {
3332
const res = await auditsList(vanta, {});
34-
35-
switch (true) {
36-
case res.ok:
37-
// The success case will be handled outside of the switch block
38-
break;
39-
case res.error instanceof SDKValidationError:
40-
// Pretty-print validation errors.
41-
return console.log(res.error.pretty());
42-
case res.error instanceof Error:
43-
return console.log(res.error);
44-
default:
45-
// TypeScript's type checking will fail on the following line if the above
46-
// cases were not exhaustive.
47-
res.error satisfies never;
48-
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
33+
if (res.ok) {
34+
const { value: result } = res;
35+
console.log(result);
36+
} else {
37+
console.log("auditsList failed:", res.error);
4938
}
50-
51-
52-
const { value: result } = res;
53-
54-
// Handle the result
55-
console.log(result);
5639
}
5740

5841
run();

0 commit comments

Comments
 (0)