vanta-auditor-api-sdk 0.2.0 → 0.4.0

package/docs/sdks/auditors/README.md

@@ -13,6 +13,7 @@ Create an auditor in Vanta.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="CreateAuditor" method="post" path="/auditors" -->
 ```typescript
 import { Vanta } from "vanta-auditor-api-sdk";
 
@@ -22,12 +23,11 @@ const vanta = new Vanta({
 
 async function run() {
   const result = await vanta.auditors.create({
-    email: "Loyal79@yahoo.com",
+    email: "Genesis_Kunze87@yahoo.com",
     givenName: "<value>",
     familyName: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,19 +50,16 @@ const vanta = new VantaCore({
 
 async function run() {
   const res = await auditorsCreate(vanta, {
-    email: "Loyal79@yahoo.com",
+    email: "Genesis_Kunze87@yahoo.com",
     givenName: "<value>",
     familyName: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("auditorsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/audits/README.md

@@ -21,6 +21,7 @@ Returns a paginated list of audits scoped to the audit firm.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="ListAudits" method="get" path="/audits" -->
 ```typescript
 import { Vanta } from "vanta-auditor-api-sdk";
 
@@ -31,7 +32,6 @@ const vanta = new Vanta({
 async function run() {
   const result = await vanta.audits.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -54,15 +54,12 @@ const vanta = new VantaCore({
 
 async function run() {
   const res = await auditsList(vanta, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("auditsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -94,6 +91,7 @@ evidence is created or has a statusUpdatedAt field that is more recent than the
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="ListAuditEvidenceUrls" method="get" path="/audits/{auditId}/evidence/{auditEvidenceId}/urls" -->
 ```typescript
 import { Vanta } from "vanta-auditor-api-sdk";
 
@@ -107,7 +105,6 @@ async function run() {
     auditEvidenceId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -133,15 +130,12 @@ async function run() {
     auditId: "<id>",
     auditEvidenceId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("auditsGetEvidenceUrls failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -172,6 +166,7 @@ Returns a paginated list of evidence for an audit.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="ListAuditEvidence" method="get" path="/audits/{auditId}/evidence" -->
 ```typescript
 import { Vanta } from "vanta-auditor-api-sdk";
 
@@ -184,7 +179,6 @@ async function run() {
     auditId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -209,15 +203,12 @@ async function run() {
   const res = await auditsListEvidence(vanta, {
     auditId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("auditsListEvidence failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -248,6 +239,7 @@ Returns a paginated list of comments for an audit.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="ListAuditComments" method="get" path="/audits/{auditId}/comments" -->
 ```typescript
 import { Vanta } from "vanta-auditor-api-sdk";
 
@@ -260,7 +252,6 @@ async function run() {
     auditId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -285,15 +276,12 @@ async function run() {
   const res = await auditsListComments(vanta, {
     auditId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("auditsListComments failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -324,6 +312,7 @@ Returns a paginated list of controls for an audit.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="ListAuditControls" method="get" path="/audits/{auditId}/controls" -->
 ```typescript
 import { Vanta } from "vanta-auditor-api-sdk";
 
@@ -336,7 +325,6 @@ async function run() {
     auditId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -361,15 +349,12 @@ async function run() {
   const res = await auditsListControls(vanta, {
     auditId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("auditsListControls failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -400,6 +385,7 @@ Create a comment in Vanta for a piece of evidence.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="CreateCommentForAuditEvidence" method="post" path="/audits/{auditId}/evidence/{auditEvidenceId}/comments" -->
 ```typescript
 import { Vanta } from "vanta-auditor-api-sdk";
 
@@ -413,12 +399,11 @@ async function run() {
     auditEvidenceId: "<id>",
     addCommentInput: {
       text: "<value>",
-      email: "Alexis74@hotmail.com",
-      creationDate: new Date("2024-08-13T11:18:40.035Z"),
+      email: "Carmen.Bogan@yahoo.com",
+      creationDate: new Date("2024-05-28T11:04:29.369Z"),
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -445,19 +430,16 @@ async function run() {
     auditEvidenceId: "<id>",
     addCommentInput: {
       text: "<value>",
-      email: "Alexis74@hotmail.com",
-      creationDate: new Date("2024-08-13T11:18:40.035Z"),
+      email: "Carmen.Bogan@yahoo.com",
+      creationDate: new Date("2024-05-28T11:04:29.369Z"),
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("auditsCreateCommentForEvidence failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -488,6 +470,7 @@ Update audit evidence.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="UpdateAuditEvidence" method="patch" path="/audits/{auditId}/evidence/{auditEvidenceId}" -->
 ```typescript
 import { Vanta } from "vanta-auditor-api-sdk";
 
@@ -502,7 +485,6 @@ async function run() {
     auditEvidenceUpdateInput: {},
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -529,15 +511,12 @@ async function run() {
     auditEvidenceId: "<id>",
     auditEvidenceUpdateInput: {},
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("auditsUpdateEvidence failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -568,6 +547,7 @@ Create a custom evidence request for an audit.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="CreateCustomEvidenceRequest" method="post" path="/audits/{auditId}/evidence/custom-evidence-requests" -->
 ```typescript
 import { Vanta } from "vanta-auditor-api-sdk";
 
@@ -580,18 +560,18 @@ async function run() {
     auditId: "<id>",
     createCustomEvidenceRequestInput: {
       controlIds: [
-        "<value>",
+        "<value 1>",
+        "<value 2>",
       ],
       title: "<value>",
-      description: "now whoa while",
-      cadence: "P3M",
+      description: "pure bludgeon deliberately question although",
+      cadence: "P1D",
       reminderWindow: "P0D",
-      isRestricted: true,
+      isRestricted: false,
       auditorEmail: "<value>",
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -617,25 +597,23 @@ async function run() {
     auditId: "<id>",
     createCustomEvidenceRequestInput: {
       controlIds: [
-        "<value>",
+        "<value 1>",
+        "<value 2>",
       ],
       title: "<value>",
-      description: "now whoa while",
-      cadence: "P3M",
+      description: "pure bludgeon deliberately question although",
+      cadence: "P1D",
       reminderWindow: "P0D",
-      isRestricted: true,
+      isRestricted: false,
       auditorEmail: "<value>",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("auditsCreateCustomEvidenceRequest failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -666,6 +644,7 @@ Create a custom control for an audit.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="CreateCustomControl" method="post" path="/audits/{auditId}/controls/custom-controls" -->
 ```typescript
 import { Vanta } from "vanta-auditor-api-sdk";
 
@@ -678,14 +657,13 @@ async function run() {
     auditId: "<id>",
     createCustomControlInput: {
       externalId: "<id>",
-      name: "<value>",
-      description: "even keenly afore mmm yearningly ouch tough yearly intent",
-      effectiveDate: new Date("2024-07-08T11:52:30.590Z"),
-      category: "THREAT_MANAGEMENT",
+      name: null,
+      description: "yet plus utter queasily what juvenile wound",
+      effectiveDate: new Date("2024-11-10T13:58:54.564Z"),
+      category: "CLOUD_SECURITY",
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -711,21 +689,18 @@ async function run() {
     auditId: "<id>",
     createCustomControlInput: {
       externalId: "<id>",
-      name: "<value>",
-      description: "even keenly afore mmm yearningly ouch tough yearly intent",
-      effectiveDate: new Date("2024-07-08T11:52:30.590Z"),
-      category: "THREAT_MANAGEMENT",
+      name: null,
+      description: "yet plus utter queasily what juvenile wound",
+      effectiveDate: new Date("2024-11-10T13:58:54.564Z"),
+      category: "CLOUD_SECURITY",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("auditsCreateCustomControl failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/examples/README.md

@@ -0,0 +1,31 @@
+# vanta-auditor-api-sdk Examples
+
+This directory contains example scripts demonstrating how to use the vanta-auditor-api-sdk SDK.
+
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
+
+## Setup
+
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
+
+2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
+
+## Running the Examples
+
+To run an example file from the examples directory:
+
+```bash
+npm run build && npx tsx example.ts
+```
+
+## Creating new examples
+
+Duplicate an existing example file, they won't be overwritten by the generation process.
+
+

package/examples/auditsList.example.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import dotenv from "dotenv";
+dotenv.config();
+/**
+ * Example usage of the vanta-auditor-api-sdk SDK
+ *
+ * To run this example from the examples directory:
+ * npm run build && npx tsx auditsList.example.ts
+ */
+
+import { Vanta } from "vanta-auditor-api-sdk";
+
+const vanta = new Vanta({
+  bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
+});
+
+async function main() {
+  const result = await vanta.audits.list({});
+
+  console.log(result);
+}
+
+main().catch(console.error);