vanta-auditor-api-sdk 0.1.1

package/src/models/operations/createcustomevidencerequest.ts

@@ -0,0 +1,87 @@
+/*
+ * 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 CreateCustomEvidenceRequestRequest = {
+  auditId: string;
+  createCustomEvidenceRequestInput: components.CreateCustomEvidenceRequestInput;
+};
+
+/** @internal */
+export const CreateCustomEvidenceRequestRequest$inboundSchema: z.ZodType<
+  CreateCustomEvidenceRequestRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  auditId: z.string(),
+  CreateCustomEvidenceRequestInput:
+    components.CreateCustomEvidenceRequestInput$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "CreateCustomEvidenceRequestInput": "createCustomEvidenceRequestInput",
+  });
+});
+
+/** @internal */
+export type CreateCustomEvidenceRequestRequest$Outbound = {
+  auditId: string;
+  CreateCustomEvidenceRequestInput:
+    components.CreateCustomEvidenceRequestInput$Outbound;
+};
+
+/** @internal */
+export const CreateCustomEvidenceRequestRequest$outboundSchema: z.ZodType<
+  CreateCustomEvidenceRequestRequest$Outbound,
+  z.ZodTypeDef,
+  CreateCustomEvidenceRequestRequest
+> = z.object({
+  auditId: z.string(),
+  createCustomEvidenceRequestInput:
+    components.CreateCustomEvidenceRequestInput$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    createCustomEvidenceRequestInput: "CreateCustomEvidenceRequestInput",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateCustomEvidenceRequestRequest$ {
+  /** @deprecated use `CreateCustomEvidenceRequestRequest$inboundSchema` instead. */
+  export const inboundSchema = CreateCustomEvidenceRequestRequest$inboundSchema;
+  /** @deprecated use `CreateCustomEvidenceRequestRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    CreateCustomEvidenceRequestRequest$outboundSchema;
+  /** @deprecated use `CreateCustomEvidenceRequestRequest$Outbound` instead. */
+  export type Outbound = CreateCustomEvidenceRequestRequest$Outbound;
+}
+
+export function createCustomEvidenceRequestRequestToJSON(
+  createCustomEvidenceRequestRequest: CreateCustomEvidenceRequestRequest,
+): string {
+  return JSON.stringify(
+    CreateCustomEvidenceRequestRequest$outboundSchema.parse(
+      createCustomEvidenceRequestRequest,
+    ),
+  );
+}
+
+export function createCustomEvidenceRequestRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateCustomEvidenceRequestRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateCustomEvidenceRequestRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateCustomEvidenceRequestRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./createcommentforauditevidence.js";
+export * from "./createcustomcontrol.js";
+export * from "./createcustomevidencerequest.js";
+export * from "./listauditcomments.js";
+export * from "./listauditcontrols.js";
+export * from "./listauditevidence.js";
+export * from "./listauditevidenceurls.js";
+export * from "./listaudits.js";
+export * from "./updateauditevidence.js";

package/src/models/operations/listauditcomments.ts

@@ -0,0 +1,83 @@
+/*
+ * 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 ListAuditCommentsRequest = {
+  auditId: string;
+  pageSize?: number | undefined;
+  pageCursor?: string | undefined;
+  /**
+   * Includes all comments that have changed since changedSinceDate.
+   */
+  changedSinceDate?: Date | undefined;
+};
+
+/** @internal */
+export const ListAuditCommentsRequest$inboundSchema: z.ZodType<
+  ListAuditCommentsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  changedSinceDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+});
+
+/** @internal */
+export type ListAuditCommentsRequest$Outbound = {
+  auditId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+  changedSinceDate?: string | undefined;
+};
+
+/** @internal */
+export const ListAuditCommentsRequest$outboundSchema: z.ZodType<
+  ListAuditCommentsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAuditCommentsRequest
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  changedSinceDate: z.date().transform(v => v.toISOString()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListAuditCommentsRequest$ {
+  /** @deprecated use `ListAuditCommentsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListAuditCommentsRequest$inboundSchema;
+  /** @deprecated use `ListAuditCommentsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListAuditCommentsRequest$outboundSchema;
+  /** @deprecated use `ListAuditCommentsRequest$Outbound` instead. */
+  export type Outbound = ListAuditCommentsRequest$Outbound;
+}
+
+export function listAuditCommentsRequestToJSON(
+  listAuditCommentsRequest: ListAuditCommentsRequest,
+): string {
+  return JSON.stringify(
+    ListAuditCommentsRequest$outboundSchema.parse(listAuditCommentsRequest),
+  );
+}
+
+export function listAuditCommentsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAuditCommentsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAuditCommentsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAuditCommentsRequest' from JSON`,
+  );
+}

package/src/models/operations/listauditcontrols.ts

@@ -0,0 +1,74 @@
+/*
+ * 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 ListAuditControlsRequest = {
+  auditId: string;
+  pageSize?: number | undefined;
+  pageCursor?: string | undefined;
+};
+
+/** @internal */
+export const ListAuditControlsRequest$inboundSchema: z.ZodType<
+  ListAuditControlsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+});
+
+/** @internal */
+export type ListAuditControlsRequest$Outbound = {
+  auditId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+};
+
+/** @internal */
+export const ListAuditControlsRequest$outboundSchema: z.ZodType<
+  ListAuditControlsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAuditControlsRequest
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: 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 ListAuditControlsRequest$ {
+  /** @deprecated use `ListAuditControlsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListAuditControlsRequest$inboundSchema;
+  /** @deprecated use `ListAuditControlsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListAuditControlsRequest$outboundSchema;
+  /** @deprecated use `ListAuditControlsRequest$Outbound` instead. */
+  export type Outbound = ListAuditControlsRequest$Outbound;
+}
+
+export function listAuditControlsRequestToJSON(
+  listAuditControlsRequest: ListAuditControlsRequest,
+): string {
+  return JSON.stringify(
+    ListAuditControlsRequest$outboundSchema.parse(listAuditControlsRequest),
+  );
+}
+
+export function listAuditControlsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAuditControlsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAuditControlsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAuditControlsRequest' from JSON`,
+  );
+}

package/src/models/operations/listauditevidence.ts

@@ -0,0 +1,83 @@
+/*
+ * 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 ListAuditEvidenceRequest = {
+  auditId: string;
+  pageSize?: number | undefined;
+  pageCursor?: string | undefined;
+  /**
+   * Includes all audit evidence that have changed since changedSinceDate.
+   */
+  changedSinceDate?: Date | undefined;
+};
+
+/** @internal */
+export const ListAuditEvidenceRequest$inboundSchema: z.ZodType<
+  ListAuditEvidenceRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  changedSinceDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+});
+
+/** @internal */
+export type ListAuditEvidenceRequest$Outbound = {
+  auditId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+  changedSinceDate?: string | undefined;
+};
+
+/** @internal */
+export const ListAuditEvidenceRequest$outboundSchema: z.ZodType<
+  ListAuditEvidenceRequest$Outbound,
+  z.ZodTypeDef,
+  ListAuditEvidenceRequest
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  changedSinceDate: z.date().transform(v => v.toISOString()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListAuditEvidenceRequest$ {
+  /** @deprecated use `ListAuditEvidenceRequest$inboundSchema` instead. */
+  export const inboundSchema = ListAuditEvidenceRequest$inboundSchema;
+  /** @deprecated use `ListAuditEvidenceRequest$outboundSchema` instead. */
+  export const outboundSchema = ListAuditEvidenceRequest$outboundSchema;
+  /** @deprecated use `ListAuditEvidenceRequest$Outbound` instead. */
+  export type Outbound = ListAuditEvidenceRequest$Outbound;
+}
+
+export function listAuditEvidenceRequestToJSON(
+  listAuditEvidenceRequest: ListAuditEvidenceRequest,
+): string {
+  return JSON.stringify(
+    ListAuditEvidenceRequest$outboundSchema.parse(listAuditEvidenceRequest),
+  );
+}
+
+export function listAuditEvidenceRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAuditEvidenceRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAuditEvidenceRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAuditEvidenceRequest' from JSON`,
+  );
+}

package/src/models/operations/listauditevidenceurls.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 ListAuditEvidenceUrlsRequest = {
+  auditId: string;
+  auditEvidenceId: string;
+  pageSize?: number | undefined;
+  pageCursor?: string | undefined;
+};
+
+/** @internal */
+export const ListAuditEvidenceUrlsRequest$inboundSchema: z.ZodType<
+  ListAuditEvidenceUrlsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  auditId: z.string(),
+  auditEvidenceId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+});
+
+/** @internal */
+export type ListAuditEvidenceUrlsRequest$Outbound = {
+  auditId: string;
+  auditEvidenceId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+};
+
+/** @internal */
+export const ListAuditEvidenceUrlsRequest$outboundSchema: z.ZodType<
+  ListAuditEvidenceUrlsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAuditEvidenceUrlsRequest
+> = z.object({
+  auditId: z.string(),
+  auditEvidenceId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: 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 ListAuditEvidenceUrlsRequest$ {
+  /** @deprecated use `ListAuditEvidenceUrlsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListAuditEvidenceUrlsRequest$inboundSchema;
+  /** @deprecated use `ListAuditEvidenceUrlsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListAuditEvidenceUrlsRequest$outboundSchema;
+  /** @deprecated use `ListAuditEvidenceUrlsRequest$Outbound` instead. */
+  export type Outbound = ListAuditEvidenceUrlsRequest$Outbound;
+}
+
+export function listAuditEvidenceUrlsRequestToJSON(
+  listAuditEvidenceUrlsRequest: ListAuditEvidenceUrlsRequest,
+): string {
+  return JSON.stringify(
+    ListAuditEvidenceUrlsRequest$outboundSchema.parse(
+      listAuditEvidenceUrlsRequest,
+    ),
+  );
+}
+
+export function listAuditEvidenceUrlsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAuditEvidenceUrlsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAuditEvidenceUrlsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAuditEvidenceUrlsRequest' from JSON`,
+  );
+}

package/src/models/operations/listaudits.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 ListAuditsRequest = {
+  pageSize?: number | undefined;
+  pageCursor?: string | undefined;
+  /**
+   * Includes all audits that have changed since changedSinceDate.
+   */
+  changedSinceDate?: Date | undefined;
+};
+
+/** @internal */
+export const ListAuditsRequest$inboundSchema: z.ZodType<
+  ListAuditsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  changedSinceDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+});
+
+/** @internal */
+export type ListAuditsRequest$Outbound = {
+  pageSize: number;
+  pageCursor?: string | undefined;
+  changedSinceDate?: string | undefined;
+};
+
+/** @internal */
+export const ListAuditsRequest$outboundSchema: z.ZodType<
+  ListAuditsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAuditsRequest
+> = z.object({
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  changedSinceDate: z.date().transform(v => v.toISOString()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListAuditsRequest$ {
+  /** @deprecated use `ListAuditsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListAuditsRequest$inboundSchema;
+  /** @deprecated use `ListAuditsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListAuditsRequest$outboundSchema;
+  /** @deprecated use `ListAuditsRequest$Outbound` instead. */
+  export type Outbound = ListAuditsRequest$Outbound;
+}
+
+export function listAuditsRequestToJSON(
+  listAuditsRequest: ListAuditsRequest,
+): string {
+  return JSON.stringify(
+    ListAuditsRequest$outboundSchema.parse(listAuditsRequest),
+  );
+}
+
+export function listAuditsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAuditsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAuditsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAuditsRequest' from JSON`,
+  );
+}

package/src/models/operations/updateauditevidence.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 UpdateAuditEvidenceRequest = {
+  auditId: string;
+  auditEvidenceId: string;
+  auditEvidenceUpdateInput: components.AuditEvidenceUpdateInput;
+};
+
+/** @internal */
+export const UpdateAuditEvidenceRequest$inboundSchema: z.ZodType<
+  UpdateAuditEvidenceRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  auditId: z.string(),
+  auditEvidenceId: z.string(),
+  AuditEvidenceUpdateInput: components.AuditEvidenceUpdateInput$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "AuditEvidenceUpdateInput": "auditEvidenceUpdateInput",
+  });
+});
+
+/** @internal */
+export type UpdateAuditEvidenceRequest$Outbound = {
+  auditId: string;
+  auditEvidenceId: string;
+  AuditEvidenceUpdateInput: components.AuditEvidenceUpdateInput$Outbound;
+};
+
+/** @internal */
+export const UpdateAuditEvidenceRequest$outboundSchema: z.ZodType<
+  UpdateAuditEvidenceRequest$Outbound,
+  z.ZodTypeDef,
+  UpdateAuditEvidenceRequest
+> = z.object({
+  auditId: z.string(),
+  auditEvidenceId: z.string(),
+  auditEvidenceUpdateInput: components.AuditEvidenceUpdateInput$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    auditEvidenceUpdateInput: "AuditEvidenceUpdateInput",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateAuditEvidenceRequest$ {
+  /** @deprecated use `UpdateAuditEvidenceRequest$inboundSchema` instead. */
+  export const inboundSchema = UpdateAuditEvidenceRequest$inboundSchema;
+  /** @deprecated use `UpdateAuditEvidenceRequest$outboundSchema` instead. */
+  export const outboundSchema = UpdateAuditEvidenceRequest$outboundSchema;
+  /** @deprecated use `UpdateAuditEvidenceRequest$Outbound` instead. */
+  export type Outbound = UpdateAuditEvidenceRequest$Outbound;
+}
+
+export function updateAuditEvidenceRequestToJSON(
+  updateAuditEvidenceRequest: UpdateAuditEvidenceRequest,
+): string {
+  return JSON.stringify(
+    UpdateAuditEvidenceRequest$outboundSchema.parse(updateAuditEvidenceRequest),
+  );
+}
+
+export function updateAuditEvidenceRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateAuditEvidenceRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateAuditEvidenceRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateAuditEvidenceRequest' from JSON`,
+  );
+}

package/src/sdk/auditors.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { auditorsCreate } from "../funcs/auditorsCreate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Auditors extends ClientSDK {
+  /**
+   * Create an auditor
+   *
+   * @remarks
+   * Create an auditor in Vanta.
+   */
+  async create(
+    request: components.AddAuditorInput,
+    options?: RequestOptions,
+  ): Promise<components.Auditor> {
+    return unwrapAsync(auditorsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}