vanta-auditor-api-sdk 0.2.0 → 0.4.0

package/src/models/components/paginatedresponseevidenceurl.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";

package/src/models/components/recurrenceduration.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { ClosedEnum } from "../../types/enums.js";
 
 export const RecurrenceDuration = {

package/src/models/components/section.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";

package/src/models/components/security.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";

package/src/models/errors/apierror.ts

@@ -2,26 +2,39 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export class APIError extends Error {
-  public readonly statusCode: number;
-  public readonly contentType: string;
+import { VantaError } from "./vantaerror.js";
 
+/** The fallback error class if no more specific error class is matched */
+export class APIError extends VantaError {
   constructor(
     message: string,
-    public readonly rawResponse: Response,
-    public readonly body: string = "",
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
   ) {
-    const statusCode = rawResponse.status;
-    const contentType = rawResponse.headers.get("content-type") || "";
-    const bodyString = body.length > 0 ? `\n${body}` : "";
-
-    super(
-      `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
-    );
-
-    this.statusCode = statusCode;
-    this.contentType = contentType;
-
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : ". ";
+    let bodyDisplay = body;
+    if (body.length > 10000) {
+      const truncated = body.substring(0, 10000);
+      const remaining = body.length - 10000;
+      bodyDisplay = `${truncated}...and ${remaining} more chars`;
+    }
+    message += `Body: ${bodyDisplay}`;
+    message = message.trim();
+    super(message, httpMeta);
     this.name = "APIError";
   }
 }

package/src/models/errors/index.ts

@@ -4,4 +4,6 @@
 
 export * from "./apierror.js";
 export * from "./httpclienterrors.js";
+export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";
+export * from "./vantaerror.js";

package/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { formatZodError } from "./sdkvalidationerror.js";
+import { VantaError } from "./vantaerror.js";
+
+export class ResponseValidationError extends VantaError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/src/models/errors/sdkvalidationerror.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 
 export class SDKValidationError extends Error {
   /**
@@ -15,6 +15,18 @@ export class SDKValidationError extends Error {
    */
   public readonly rawMessage: unknown;
 
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
   constructor(message: string, cause: unknown, rawValue: unknown) {
     super(`${message}: ${cause}`);
     this.name = "SDKValidationError";

package/src/models/errors/vantaerror.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class VantaError extends Error {
+  /** HTTP status code */
+  public readonly statusCode: number;
+  /** HTTP body */
+  public readonly body: string;
+  /** HTTP headers */
+  public readonly headers: Headers;
+  /** HTTP content type */
+  public readonly contentType: string;
+  /** Raw response */
+  public readonly rawResponse: Response;
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.statusCode = httpMeta.response.status;
+    this.body = httpMeta.body;
+    this.headers = httpMeta.response.headers;
+    this.contentType = httpMeta.response.headers.get("content-type") || "";
+    this.rawResponse = httpMeta.response;
+
+    this.name = "VantaError";
+  }
+}

package/src/models/operations/createcommentforauditevidence.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

package/src/models/operations/createcustomcontrol.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

package/src/models/operations/createcustomevidencerequest.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

package/src/models/operations/listauditcomments.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";

package/src/models/operations/listauditcontrols.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";

package/src/models/operations/listauditevidence.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";

package/src/models/operations/listauditevidenceurls.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";

package/src/models/operations/listaudits.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -14,6 +14,10 @@ export type ListAuditsRequest = {
    * Includes all audits that have changed since changedSinceDate.
    */
   changedSinceDate?: Date | undefined;
+  /**
+   * Includes only audits with no audit report uploaded
+   */
+  isActiveAudit?: boolean | undefined;
 };
 
 /** @internal */
@@ -27,6 +31,7 @@ export const ListAuditsRequest$inboundSchema: z.ZodType<
   changedSinceDate: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ).optional(),
+  isActiveAudit: z.boolean().optional(),
 });
 
 /** @internal */
@@ -34,6 +39,7 @@ export type ListAuditsRequest$Outbound = {
   pageSize: number;
   pageCursor?: string | undefined;
   changedSinceDate?: string | undefined;
+  isActiveAudit?: boolean | undefined;
 };
 
 /** @internal */
@@ -45,6 +51,7 @@ export const ListAuditsRequest$outboundSchema: z.ZodType<
   pageSize: z.number().int().default(10),
   pageCursor: z.string().optional(),
   changedSinceDate: z.date().transform(v => v.toISOString()).optional(),
+  isActiveAudit: z.boolean().optional(),
 });
 
 /**

package/src/models/operations/updateauditevidence.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";

package/src/types/blobs.ts

@@ -2,13 +2,14 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 
-export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> =
-  z.custom<Blob>(isBlobLike, {
-    message: "expected a Blob, File or Blob-like object",
-    fatal: true,
-  });
+export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> = z.custom<
+  Blob
+>(isBlobLike, {
+  message: "expected a Blob, File or Blob-like object",
+  fatal: true,
+});
 
 export function isBlobLike(val: unknown): val is Blob {
   if (val instanceof Blob) {

package/src/types/constdatetime.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 
 export function constDateTime(
   val: string,
@@ -11,5 +11,5 @@ export function constDateTime(
     return (
       typeof v === "string" && new Date(v).getTime() === new Date(val).getTime()
     );
-  }, `Value must be equivelant to ${val}`);
+  }, `Value must be equivalent to ${val}`);
 }

package/types/blobs.d.ts

@@ -1,4 +1,4 @@
-import * as z from "zod";
+import * as z from "zod/v3";
 export declare const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob>;
 export declare function isBlobLike(val: unknown): val is Blob;
 //# sourceMappingURL=blobs.d.ts.map

package/types/blobs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blobs.d.ts","sourceRoot":"","sources":["../src/types/blobs.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,CAI3D,CAAC;AAEL,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,IAAI,CAkBpD"}
+{"version":3,"file":"blobs.d.ts","sourceRoot":"","sources":["../src/types/blobs.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,CAK7D,CAAC;AAEH,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,IAAI,CAkBpD"}

package/types/blobs.js

@@ -38,7 +38,7 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.blobLikeSchema = void 0;
 exports.isBlobLike = isBlobLike;
-const z = __importStar(require("zod"));
+const z = __importStar(require("zod/v3"));
 exports.blobLikeSchema = z.custom(isBlobLike, {
     message: "expected a Blob, File or Blob-like object",
     fatal: true,

package/types/blobs.js.map

@@ -1 +1 @@
-{"version":3,"file":"blobs.js","sourceRoot":"","sources":["../src/types/blobs.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAUH,gCAkBC;AA1BD,uCAAyB;AAEZ,QAAA,cAAc,GACzB,CAAC,CAAC,MAAM,CAAO,UAAU,EAAE;IACzB,OAAO,EAAE,2CAA2C;IACpD,KAAK,EAAE,IAAI;CACZ,CAAC,CAAC;AAEL,SAAgB,UAAU,CAAC,GAAY;IACrC,IAAI,GAAG,YAAY,IAAI,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,WAAW,IAAI,GAAG,CAAC,EAAE,CAAC;QAC3E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACrC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,QAAQ,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU,CAAC;AAC7D,CAAC"}
+{"version":3,"file":"blobs.js","sourceRoot":"","sources":["../src/types/blobs.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAWH,gCAkBC;AA3BD,0CAA4B;AAEf,QAAA,cAAc,GAAwC,CAAC,CAAC,MAAM,CAEzE,UAAU,EAAE;IACZ,OAAO,EAAE,2CAA2C;IACpD,KAAK,EAAE,IAAI;CACZ,CAAC,CAAC;AAEH,SAAgB,UAAU,CAAC,GAAY;IACrC,IAAI,GAAG,YAAY,IAAI,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,IAAI,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,WAAW,IAAI,GAAG,CAAC,EAAE,CAAC;QAC3E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACrC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,QAAQ,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU,CAAC;AAC7D,CAAC"}

package/types/constdatetime.d.ts

@@ -1,3 +1,3 @@
-import * as z from "zod";
+import * as z from "zod/v3";
 export declare function constDateTime(val: string): z.ZodType<string, z.ZodTypeDef, unknown>;
 //# sourceMappingURL=constdatetime.d.ts.map

package/types/constdatetime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constdatetime.d.ts","sourceRoot":"","sources":["../src/types/constdatetime.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,wBAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,GACV,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAM1C"}
+{"version":3,"file":"constdatetime.d.ts","sourceRoot":"","sources":["../src/types/constdatetime.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,wBAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,GACV,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAM1C"}

package/types/constdatetime.js

@@ -37,10 +37,10 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.constDateTime = constDateTime;
-const z = __importStar(require("zod"));
+const z = __importStar(require("zod/v3"));
 function constDateTime(val) {
     return z.custom((v) => {
         return (typeof v === "string" && new Date(v).getTime() === new Date(val).getTime());
-    }, `Value must be equivelant to ${val}`);
+    }, `Value must be equivalent to ${val}`);
 }
 //# sourceMappingURL=constdatetime.js.map

package/types/constdatetime.js.map

@@ -1 +1 @@
-{"version":3,"file":"constdatetime.js","sourceRoot":"","sources":["../src/types/constdatetime.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIH,sCAQC;AAVD,uCAAyB;AAEzB,SAAgB,aAAa,CAC3B,GAAW;IAEX,OAAO,CAAC,CAAC,MAAM,CAAS,CAAC,CAAC,EAAE,EAAE;QAC5B,OAAO,CACL,OAAO,CAAC,KAAK,QAAQ,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAC3E,CAAC;IACJ,CAAC,EAAE,+BAA+B,GAAG,EAAE,CAAC,CAAC;AAC3C,CAAC"}
+{"version":3,"file":"constdatetime.js","sourceRoot":"","sources":["../src/types/constdatetime.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIH,sCAQC;AAVD,0CAA4B;AAE5B,SAAgB,aAAa,CAC3B,GAAW;IAEX,OAAO,CAAC,CAAC,MAAM,CAAS,CAAC,CAAC,EAAE,EAAE;QAC5B,OAAO,CACL,OAAO,CAAC,KAAK,QAAQ,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAC3E,CAAC;IACJ,CAAC,EAAE,+BAA+B,GAAG,EAAE,CAAC,CAAC;AAC3C,CAAC"}

package/docs/sdks/vanta/README.md

@@ -1,7 +0,0 @@
-# Vanta SDK
-
-## Overview
-
-Conduct an audit: The Auditor API lets audit firms conduct audits from a tool outside of Vanta. Unlock data syncing with Vanta through this API.
-
-### Available Operations