vanta-auditor-api-sdk 0.1.1

package/src/models/components/paginatedresponseevidenceurl.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  EvidenceUrl,
+  EvidenceUrl$inboundSchema,
+  EvidenceUrl$Outbound,
+  EvidenceUrl$outboundSchema,
+} from "./evidenceurl.js";
+import {
+  PageInfo,
+  PageInfo$inboundSchema,
+  PageInfo$Outbound,
+  PageInfo$outboundSchema,
+} from "./pageinfo.js";
+
+export type PaginatedResponseEvidenceUrlResults = {
+  data: Array<EvidenceUrl>;
+  /**
+   * Provides information about the pagination of a dataset.
+   */
+  pageInfo: PageInfo;
+};
+
+export type PaginatedResponseEvidenceUrl = {
+  results: PaginatedResponseEvidenceUrlResults;
+};
+
+/** @internal */
+export const PaginatedResponseEvidenceUrlResults$inboundSchema: z.ZodType<
+  PaginatedResponseEvidenceUrlResults,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(EvidenceUrl$inboundSchema),
+  pageInfo: PageInfo$inboundSchema,
+});
+
+/** @internal */
+export type PaginatedResponseEvidenceUrlResults$Outbound = {
+  data: Array<EvidenceUrl$Outbound>;
+  pageInfo: PageInfo$Outbound;
+};
+
+/** @internal */
+export const PaginatedResponseEvidenceUrlResults$outboundSchema: z.ZodType<
+  PaginatedResponseEvidenceUrlResults$Outbound,
+  z.ZodTypeDef,
+  PaginatedResponseEvidenceUrlResults
+> = z.object({
+  data: z.array(EvidenceUrl$outboundSchema),
+  pageInfo: PageInfo$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaginatedResponseEvidenceUrlResults$ {
+  /** @deprecated use `PaginatedResponseEvidenceUrlResults$inboundSchema` instead. */
+  export const inboundSchema =
+    PaginatedResponseEvidenceUrlResults$inboundSchema;
+  /** @deprecated use `PaginatedResponseEvidenceUrlResults$outboundSchema` instead. */
+  export const outboundSchema =
+    PaginatedResponseEvidenceUrlResults$outboundSchema;
+  /** @deprecated use `PaginatedResponseEvidenceUrlResults$Outbound` instead. */
+  export type Outbound = PaginatedResponseEvidenceUrlResults$Outbound;
+}
+
+export function paginatedResponseEvidenceUrlResultsToJSON(
+  paginatedResponseEvidenceUrlResults: PaginatedResponseEvidenceUrlResults,
+): string {
+  return JSON.stringify(
+    PaginatedResponseEvidenceUrlResults$outboundSchema.parse(
+      paginatedResponseEvidenceUrlResults,
+    ),
+  );
+}
+
+export function paginatedResponseEvidenceUrlResultsFromJSON(
+  jsonString: string,
+): SafeParseResult<PaginatedResponseEvidenceUrlResults, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PaginatedResponseEvidenceUrlResults$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaginatedResponseEvidenceUrlResults' from JSON`,
+  );
+}
+
+/** @internal */
+export const PaginatedResponseEvidenceUrl$inboundSchema: z.ZodType<
+  PaginatedResponseEvidenceUrl,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  results: z.lazy(() => PaginatedResponseEvidenceUrlResults$inboundSchema),
+});
+
+/** @internal */
+export type PaginatedResponseEvidenceUrl$Outbound = {
+  results: PaginatedResponseEvidenceUrlResults$Outbound;
+};
+
+/** @internal */
+export const PaginatedResponseEvidenceUrl$outboundSchema: z.ZodType<
+  PaginatedResponseEvidenceUrl$Outbound,
+  z.ZodTypeDef,
+  PaginatedResponseEvidenceUrl
+> = z.object({
+  results: z.lazy(() => PaginatedResponseEvidenceUrlResults$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaginatedResponseEvidenceUrl$ {
+  /** @deprecated use `PaginatedResponseEvidenceUrl$inboundSchema` instead. */
+  export const inboundSchema = PaginatedResponseEvidenceUrl$inboundSchema;
+  /** @deprecated use `PaginatedResponseEvidenceUrl$outboundSchema` instead. */
+  export const outboundSchema = PaginatedResponseEvidenceUrl$outboundSchema;
+  /** @deprecated use `PaginatedResponseEvidenceUrl$Outbound` instead. */
+  export type Outbound = PaginatedResponseEvidenceUrl$Outbound;
+}
+
+export function paginatedResponseEvidenceUrlToJSON(
+  paginatedResponseEvidenceUrl: PaginatedResponseEvidenceUrl,
+): string {
+  return JSON.stringify(
+    PaginatedResponseEvidenceUrl$outboundSchema.parse(
+      paginatedResponseEvidenceUrl,
+    ),
+  );
+}
+
+export function paginatedResponseEvidenceUrlFromJSON(
+  jsonString: string,
+): SafeParseResult<PaginatedResponseEvidenceUrl, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaginatedResponseEvidenceUrl$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaginatedResponseEvidenceUrl' from JSON`,
+  );
+}

package/src/models/components/recurrenceduration.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const RecurrenceDuration = {
+  P0D: "P0D",
+  P1D: "P1D",
+  P1W: "P1W",
+  P1M: "P1M",
+  P3M: "P3M",
+  P6M: "P6M",
+  P1Y: "P1Y",
+} as const;
+export type RecurrenceDuration = ClosedEnum<typeof RecurrenceDuration>;
+
+/** @internal */
+export const RecurrenceDuration$inboundSchema: z.ZodNativeEnum<
+  typeof RecurrenceDuration
+> = z.nativeEnum(RecurrenceDuration);
+
+/** @internal */
+export const RecurrenceDuration$outboundSchema: z.ZodNativeEnum<
+  typeof RecurrenceDuration
+> = RecurrenceDuration$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RecurrenceDuration$ {
+  /** @deprecated use `RecurrenceDuration$inboundSchema` instead. */
+  export const inboundSchema = RecurrenceDuration$inboundSchema;
+  /** @deprecated use `RecurrenceDuration$outboundSchema` instead. */
+  export const outboundSchema = RecurrenceDuration$outboundSchema;
+}

package/src/models/components/security.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type Security = {
+  bearerAuth?: string | undefined;
+};
+
+/** @internal */
+export const Security$inboundSchema: z.ZodType<
+  Security,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bearerAuth: z.string().optional(),
+});
+
+/** @internal */
+export type Security$Outbound = {
+  bearerAuth?: string | undefined;
+};
+
+/** @internal */
+export const Security$outboundSchema: z.ZodType<
+  Security$Outbound,
+  z.ZodTypeDef,
+  Security
+> = z.object({
+  bearerAuth: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Security$ {
+  /** @deprecated use `Security$inboundSchema` instead. */
+  export const inboundSchema = Security$inboundSchema;
+  /** @deprecated use `Security$outboundSchema` instead. */
+  export const outboundSchema = Security$outboundSchema;
+  /** @deprecated use `Security$Outbound` instead. */
+  export type Outbound = Security$Outbound;
+}
+
+export function securityToJSON(security: Security): string {
+  return JSON.stringify(Security$outboundSchema.parse(security));
+}
+
+export function securityFromJSON(
+  jsonString: string,
+): SafeParseResult<Security, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Security$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Security' from JSON`,
+  );
+}

package/src/models/errors/apierror.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export class APIError extends Error {
+  public readonly statusCode: number;
+  public readonly contentType: string;
+
+  constructor(
+    message: string,
+    public readonly rawResponse: Response,
+    public readonly 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;
+
+    this.name = "APIError";
+  }
+}

package/src/models/errors/httpclienterrors.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Base class for all HTTP errors.
+ */
+export class HTTPClientError extends Error {
+  /** The underlying cause of the error. */
+  override readonly cause: unknown;
+  override name = "HTTPClientError";
+  constructor(message: string, opts?: { cause?: unknown }) {
+    let msg = message;
+    if (opts?.cause) {
+      msg += `: ${opts.cause}`;
+    }
+
+    super(msg, opts);
+    // In older runtimes, the cause field would not have been assigned through
+    // the super() call.
+    if (typeof this.cause === "undefined") {
+      this.cause = opts?.cause;
+    }
+  }
+}
+
+/**
+ * An error to capture unrecognised or unexpected errors when making HTTP calls.
+ */
+export class UnexpectedClientError extends HTTPClientError {
+  override name = "UnexpectedClientError";
+}
+
+/**
+ * An error that is raised when any inputs used to create a request are invalid.
+ */
+export class InvalidRequestError extends HTTPClientError {
+  override name = "InvalidRequestError";
+}
+
+/**
+ * An error that is raised when a HTTP request was aborted by the client error.
+ */
+export class RequestAbortedError extends HTTPClientError {
+  override readonly name = "RequestAbortedError";
+}
+
+/**
+ * An error that is raised when a HTTP request timed out due to an AbortSignal
+ * signal timeout.
+ */
+export class RequestTimeoutError extends HTTPClientError {
+  override readonly name = "RequestTimeoutError";
+}
+
+/**
+ * An error that is raised when a HTTP client is unable to make a request to
+ * a server.
+ */
+export class ConnectionError extends HTTPClientError {
+  override readonly name = "ConnectionError";
+}

package/src/models/errors/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./apierror.js";
+export * from "./httpclienterrors.js";
+export * from "./sdkvalidationerror.js";

package/src/models/errors/sdkvalidationerror.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export class SDKValidationError extends Error {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(message: string, cause: unknown, rawValue: unknown) {
+    super(`${message}: ${cause}`);
+    this.name = "SDKValidationError";
+    this.cause = cause;
+    this.rawValue = rawValue;
+    this.rawMessage = message;
+  }
+
+  /**
+   * 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();
+    }
+  }
+}
+
+export function formatZodError(err: z.ZodError, level = 0): string {
+  let pre = "  ".repeat(level);
+  pre = level > 0 ? `│${pre}` : pre;
+  pre += " ".repeat(level);
+
+  let message = "";
+  const append = (str: string) => (message += `\n${pre}${str}`);
+
+  const len = err.issues.length;
+  const headline = len === 1 ? `${len} issue found` : `${len} issues found`;
+
+  if (len) {
+    append(`┌ ${headline}:`);
+  }
+
+  for (const issue of err.issues) {
+    let path = issue.path.join(".");
+    path = path ? `<root>.${path}` : "<root>";
+    append(`│ • [${path}]: ${issue.message} (${issue.code})`);
+    switch (issue.code) {
+      case "invalid_literal":
+      case "invalid_type": {
+        append(`│     Want: ${issue.expected}`);
+        append(`│      Got: ${issue.received}`);
+        break;
+      }
+      case "unrecognized_keys": {
+        append(`│     Keys: ${issue.keys.join(", ")}`);
+        break;
+      }
+      case "invalid_enum_value": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        append(`│         Got: ${issue.received}`);
+        break;
+      }
+      case "invalid_union_discriminator": {
+        append(`│     Allowed: ${issue.options.join(", ")}`);
+        break;
+      }
+      case "invalid_union": {
+        const len = issue.unionErrors.length;
+        append(
+          `│   ✖︎ Attemped to deserialize into one of ${len} union members:`,
+        );
+        issue.unionErrors.forEach((err, i) => {
+          append(`│   ✖︎ Member ${i + 1} of ${len}`);
+          append(`${formatZodError(err, level + 1)}`);
+        });
+      }
+    }
+  }
+
+  if (err.issues.length) {
+    append(`└─*`);
+  }
+
+  return message.slice(1);
+}

package/src/models/operations/createcommentforauditevidence.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CreateCommentForAuditEvidenceRequest = {
+  auditId: string;
+  auditEvidenceId: string;
+  addCommentInput: components.AddCommentInput;
+};
+
+/** @internal */
+export const CreateCommentForAuditEvidenceRequest$inboundSchema: z.ZodType<
+  CreateCommentForAuditEvidenceRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  auditId: z.string(),
+  auditEvidenceId: z.string(),
+  AddCommentInput: components.AddCommentInput$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "AddCommentInput": "addCommentInput",
+  });
+});
+
+/** @internal */
+export type CreateCommentForAuditEvidenceRequest$Outbound = {
+  auditId: string;
+  auditEvidenceId: string;
+  AddCommentInput: components.AddCommentInput$Outbound;
+};
+
+/** @internal */
+export const CreateCommentForAuditEvidenceRequest$outboundSchema: z.ZodType<
+  CreateCommentForAuditEvidenceRequest$Outbound,
+  z.ZodTypeDef,
+  CreateCommentForAuditEvidenceRequest
+> = z.object({
+  auditId: z.string(),
+  auditEvidenceId: z.string(),
+  addCommentInput: components.AddCommentInput$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    addCommentInput: "AddCommentInput",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateCommentForAuditEvidenceRequest$ {
+  /** @deprecated use `CreateCommentForAuditEvidenceRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    CreateCommentForAuditEvidenceRequest$inboundSchema;
+  /** @deprecated use `CreateCommentForAuditEvidenceRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    CreateCommentForAuditEvidenceRequest$outboundSchema;
+  /** @deprecated use `CreateCommentForAuditEvidenceRequest$Outbound` instead. */
+  export type Outbound = CreateCommentForAuditEvidenceRequest$Outbound;
+}
+
+export function createCommentForAuditEvidenceRequestToJSON(
+  createCommentForAuditEvidenceRequest: CreateCommentForAuditEvidenceRequest,
+): string {
+  return JSON.stringify(
+    CreateCommentForAuditEvidenceRequest$outboundSchema.parse(
+      createCommentForAuditEvidenceRequest,
+    ),
+  );
+}
+
+export function createCommentForAuditEvidenceRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateCommentForAuditEvidenceRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateCommentForAuditEvidenceRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateCommentForAuditEvidenceRequest' from JSON`,
+  );
+}

package/src/models/operations/createcustomcontrol.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CreateCustomControlRequest = {
+  auditId: string;
+  createCustomControlInput: components.CreateCustomControlInput;
+};
+
+/** @internal */
+export const CreateCustomControlRequest$inboundSchema: z.ZodType<
+  CreateCustomControlRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  auditId: z.string(),
+  CreateCustomControlInput: components.CreateCustomControlInput$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "CreateCustomControlInput": "createCustomControlInput",
+  });
+});
+
+/** @internal */
+export type CreateCustomControlRequest$Outbound = {
+  auditId: string;
+  CreateCustomControlInput: components.CreateCustomControlInput$Outbound;
+};
+
+/** @internal */
+export const CreateCustomControlRequest$outboundSchema: z.ZodType<
+  CreateCustomControlRequest$Outbound,
+  z.ZodTypeDef,
+  CreateCustomControlRequest
+> = z.object({
+  auditId: z.string(),
+  createCustomControlInput: components.CreateCustomControlInput$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    createCustomControlInput: "CreateCustomControlInput",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateCustomControlRequest$ {
+  /** @deprecated use `CreateCustomControlRequest$inboundSchema` instead. */
+  export const inboundSchema = CreateCustomControlRequest$inboundSchema;
+  /** @deprecated use `CreateCustomControlRequest$outboundSchema` instead. */
+  export const outboundSchema = CreateCustomControlRequest$outboundSchema;
+  /** @deprecated use `CreateCustomControlRequest$Outbound` instead. */
+  export type Outbound = CreateCustomControlRequest$Outbound;
+}
+
+export function createCustomControlRequestToJSON(
+  createCustomControlRequest: CreateCustomControlRequest,
+): string {
+  return JSON.stringify(
+    CreateCustomControlRequest$outboundSchema.parse(createCustomControlRequest),
+  );
+}
+
+export function createCustomControlRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateCustomControlRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateCustomControlRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateCustomControlRequest' from JSON`,
+  );
+}