vanta-auditor-api-sdk 0.1.1

package/src/models/components/auditevidenceupdateinput.ts

@@ -0,0 +1,132 @@
+/*
+ * 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 {
+  AuditorEnabledStateTransition,
+  AuditorEnabledStateTransition$inboundSchema,
+  AuditorEnabledStateTransition$outboundSchema,
+} from "./auditorenabledstatetransition.js";
+
+export type StatusUpdate = {
+  /**
+   * Email of the auditor who changed the state
+   */
+  auditorEmail: string;
+  stateTransition: AuditorEnabledStateTransition;
+};
+
+export type AuditEvidenceUpdateInput = {
+  statusUpdate?: StatusUpdate | undefined;
+};
+
+/** @internal */
+export const StatusUpdate$inboundSchema: z.ZodType<
+  StatusUpdate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  auditorEmail: z.string(),
+  stateTransition: AuditorEnabledStateTransition$inboundSchema,
+});
+
+/** @internal */
+export type StatusUpdate$Outbound = {
+  auditorEmail: string;
+  stateTransition: string;
+};
+
+/** @internal */
+export const StatusUpdate$outboundSchema: z.ZodType<
+  StatusUpdate$Outbound,
+  z.ZodTypeDef,
+  StatusUpdate
+> = z.object({
+  auditorEmail: z.string(),
+  stateTransition: AuditorEnabledStateTransition$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace StatusUpdate$ {
+  /** @deprecated use `StatusUpdate$inboundSchema` instead. */
+  export const inboundSchema = StatusUpdate$inboundSchema;
+  /** @deprecated use `StatusUpdate$outboundSchema` instead. */
+  export const outboundSchema = StatusUpdate$outboundSchema;
+  /** @deprecated use `StatusUpdate$Outbound` instead. */
+  export type Outbound = StatusUpdate$Outbound;
+}
+
+export function statusUpdateToJSON(statusUpdate: StatusUpdate): string {
+  return JSON.stringify(StatusUpdate$outboundSchema.parse(statusUpdate));
+}
+
+export function statusUpdateFromJSON(
+  jsonString: string,
+): SafeParseResult<StatusUpdate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StatusUpdate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StatusUpdate' from JSON`,
+  );
+}
+
+/** @internal */
+export const AuditEvidenceUpdateInput$inboundSchema: z.ZodType<
+  AuditEvidenceUpdateInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  statusUpdate: z.lazy(() => StatusUpdate$inboundSchema).optional(),
+});
+
+/** @internal */
+export type AuditEvidenceUpdateInput$Outbound = {
+  statusUpdate?: StatusUpdate$Outbound | undefined;
+};
+
+/** @internal */
+export const AuditEvidenceUpdateInput$outboundSchema: z.ZodType<
+  AuditEvidenceUpdateInput$Outbound,
+  z.ZodTypeDef,
+  AuditEvidenceUpdateInput
+> = z.object({
+  statusUpdate: z.lazy(() => StatusUpdate$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AuditEvidenceUpdateInput$ {
+  /** @deprecated use `AuditEvidenceUpdateInput$inboundSchema` instead. */
+  export const inboundSchema = AuditEvidenceUpdateInput$inboundSchema;
+  /** @deprecated use `AuditEvidenceUpdateInput$outboundSchema` instead. */
+  export const outboundSchema = AuditEvidenceUpdateInput$outboundSchema;
+  /** @deprecated use `AuditEvidenceUpdateInput$Outbound` instead. */
+  export type Outbound = AuditEvidenceUpdateInput$Outbound;
+}
+
+export function auditEvidenceUpdateInputToJSON(
+  auditEvidenceUpdateInput: AuditEvidenceUpdateInput,
+): string {
+  return JSON.stringify(
+    AuditEvidenceUpdateInput$outboundSchema.parse(auditEvidenceUpdateInput),
+  );
+}
+
+export function auditEvidenceUpdateInputFromJSON(
+  jsonString: string,
+): SafeParseResult<AuditEvidenceUpdateInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuditEvidenceUpdateInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuditEvidenceUpdateInput' from JSON`,
+  );
+}

package/src/models/components/auditor.ts

@@ -0,0 +1,87 @@
+/*
+ * 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 Auditor = {
+  id: string;
+  /**
+   * The unique identifier for the organization.
+   */
+  organizationId: string;
+  /**
+   * The email address of the auditor.
+   */
+  email: string;
+  /**
+   * The given name (first name) of the auditor.
+   */
+  givenName: string;
+  /**
+   * The family name (last name) of the auditor.
+   */
+  familyName: string;
+};
+
+/** @internal */
+export const Auditor$inboundSchema: z.ZodType<Auditor, z.ZodTypeDef, unknown> =
+  z.object({
+    id: z.string(),
+    organizationId: z.string(),
+    email: z.string(),
+    givenName: z.string(),
+    familyName: z.string(),
+  });
+
+/** @internal */
+export type Auditor$Outbound = {
+  id: string;
+  organizationId: string;
+  email: string;
+  givenName: string;
+  familyName: string;
+};
+
+/** @internal */
+export const Auditor$outboundSchema: z.ZodType<
+  Auditor$Outbound,
+  z.ZodTypeDef,
+  Auditor
+> = z.object({
+  id: z.string(),
+  organizationId: z.string(),
+  email: z.string(),
+  givenName: z.string(),
+  familyName: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Auditor$ {
+  /** @deprecated use `Auditor$inboundSchema` instead. */
+  export const inboundSchema = Auditor$inboundSchema;
+  /** @deprecated use `Auditor$outboundSchema` instead. */
+  export const outboundSchema = Auditor$outboundSchema;
+  /** @deprecated use `Auditor$Outbound` instead. */
+  export type Outbound = Auditor$Outbound;
+}
+
+export function auditorToJSON(auditor: Auditor): string {
+  return JSON.stringify(Auditor$outboundSchema.parse(auditor));
+}
+
+export function auditorFromJSON(
+  jsonString: string,
+): SafeParseResult<Auditor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Auditor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Auditor' from JSON`,
+  );
+}

package/src/models/components/auditorcontrol.ts

@@ -0,0 +1,194 @@
+/*
+ * 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 {
+  ControlSource,
+  ControlSource$inboundSchema,
+  ControlSource$outboundSchema,
+} from "./controlsource.js";
+
+/**
+ * The control's owner.
+ */
+export type Owner = {
+  /**
+   * Unique identifier for the person.
+   */
+  id: string;
+  /**
+   * Name of the person that is shown in product.
+   */
+  displayName: string;
+  /**
+   * Email address of the person.
+   */
+  emailAddress: string;
+};
+
+export type AuditorControl = {
+  /**
+   * The control's unique ID.
+   */
+  id: string;
+  /**
+   * The control's external ID.
+   */
+  externalId: string | null;
+  /**
+   * The control's name.
+   */
+  name: string;
+  /**
+   * The control's description.
+   */
+  description: string;
+  source: ControlSource;
+  /**
+   * The security domains that the control belongs to.
+   */
+  domains: Array<string>;
+  /**
+   * The control's owner.
+   */
+  owner: Owner | null;
+  /**
+   * The control's GDPR role, if the control is a GDPR control.
+   */
+  role?: string | undefined;
+  /**
+   * The report standard framework fulfilled by the control.
+   */
+  framework: string;
+};
+
+/** @internal */
+export const Owner$inboundSchema: z.ZodType<Owner, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string(),
+    displayName: z.string(),
+    emailAddress: z.string(),
+  });
+
+/** @internal */
+export type Owner$Outbound = {
+  id: string;
+  displayName: string;
+  emailAddress: string;
+};
+
+/** @internal */
+export const Owner$outboundSchema: z.ZodType<
+  Owner$Outbound,
+  z.ZodTypeDef,
+  Owner
+> = z.object({
+  id: z.string(),
+  displayName: z.string(),
+  emailAddress: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Owner$ {
+  /** @deprecated use `Owner$inboundSchema` instead. */
+  export const inboundSchema = Owner$inboundSchema;
+  /** @deprecated use `Owner$outboundSchema` instead. */
+  export const outboundSchema = Owner$outboundSchema;
+  /** @deprecated use `Owner$Outbound` instead. */
+  export type Outbound = Owner$Outbound;
+}
+
+export function ownerToJSON(owner: Owner): string {
+  return JSON.stringify(Owner$outboundSchema.parse(owner));
+}
+
+export function ownerFromJSON(
+  jsonString: string,
+): SafeParseResult<Owner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Owner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Owner' from JSON`,
+  );
+}
+
+/** @internal */
+export const AuditorControl$inboundSchema: z.ZodType<
+  AuditorControl,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  externalId: z.nullable(z.string()),
+  name: z.string(),
+  description: z.string(),
+  source: ControlSource$inboundSchema,
+  domains: z.array(z.string()),
+  owner: z.nullable(z.lazy(() => Owner$inboundSchema)),
+  role: z.string().optional(),
+  framework: z.string(),
+});
+
+/** @internal */
+export type AuditorControl$Outbound = {
+  id: string;
+  externalId: string | null;
+  name: string;
+  description: string;
+  source: string;
+  domains: Array<string>;
+  owner: Owner$Outbound | null;
+  role?: string | undefined;
+  framework: string;
+};
+
+/** @internal */
+export const AuditorControl$outboundSchema: z.ZodType<
+  AuditorControl$Outbound,
+  z.ZodTypeDef,
+  AuditorControl
+> = z.object({
+  id: z.string(),
+  externalId: z.nullable(z.string()),
+  name: z.string(),
+  description: z.string(),
+  source: ControlSource$outboundSchema,
+  domains: z.array(z.string()),
+  owner: z.nullable(z.lazy(() => Owner$outboundSchema)),
+  role: z.string().optional(),
+  framework: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AuditorControl$ {
+  /** @deprecated use `AuditorControl$inboundSchema` instead. */
+  export const inboundSchema = AuditorControl$inboundSchema;
+  /** @deprecated use `AuditorControl$outboundSchema` instead. */
+  export const outboundSchema = AuditorControl$outboundSchema;
+  /** @deprecated use `AuditorControl$Outbound` instead. */
+  export type Outbound = AuditorControl$Outbound;
+}
+
+export function auditorControlToJSON(auditorControl: AuditorControl): string {
+  return JSON.stringify(AuditorControl$outboundSchema.parse(auditorControl));
+}
+
+export function auditorControlFromJSON(
+  jsonString: string,
+): SafeParseResult<AuditorControl, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuditorControl$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuditorControl' from JSON`,
+  );
+}

package/src/models/components/auditorenabledstatetransition.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const AuditorEnabledStateTransition = {
+  Accept: "ACCEPT",
+  MarkApplicable: "MARK_APPLICABLE",
+  Flag: "FLAG",
+  MarkNa: "MARK_NA",
+} as const;
+export type AuditorEnabledStateTransition = ClosedEnum<
+  typeof AuditorEnabledStateTransition
+>;
+
+/** @internal */
+export const AuditorEnabledStateTransition$inboundSchema: z.ZodNativeEnum<
+  typeof AuditorEnabledStateTransition
+> = z.nativeEnum(AuditorEnabledStateTransition);
+
+/** @internal */
+export const AuditorEnabledStateTransition$outboundSchema: z.ZodNativeEnum<
+  typeof AuditorEnabledStateTransition
+> = AuditorEnabledStateTransition$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AuditorEnabledStateTransition$ {
+  /** @deprecated use `AuditorEnabledStateTransition$inboundSchema` instead. */
+  export const inboundSchema = AuditorEnabledStateTransition$inboundSchema;
+  /** @deprecated use `AuditorEnabledStateTransition$outboundSchema` instead. */
+  export const outboundSchema = AuditorEnabledStateTransition$outboundSchema;
+}

package/src/models/components/comment.ts

@@ -0,0 +1,101 @@
+/*
+ * 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 Comment = {
+  /**
+   * The unique identifier for the comment
+   */
+  id: string;
+  /**
+   * The unique identifier for the audit evidence related to the comment.
+   */
+  auditEvidenceId: string;
+  /**
+   * The comment message
+   */
+  text: string;
+  /**
+   * When the comment was created
+   */
+  creationDate: Date;
+  /**
+   * When the comment was updated
+   */
+  modificationDate: Date | null;
+  /**
+   * The email of the comment author. This acts as a unique identifier to map users between Vanta and external systems.
+   */
+  email: string | null;
+};
+
+/** @internal */
+export const Comment$inboundSchema: z.ZodType<Comment, z.ZodTypeDef, unknown> =
+  z.object({
+    id: z.string(),
+    auditEvidenceId: z.string(),
+    text: z.string(),
+    creationDate: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    modificationDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ),
+    email: z.nullable(z.string()),
+  });
+
+/** @internal */
+export type Comment$Outbound = {
+  id: string;
+  auditEvidenceId: string;
+  text: string;
+  creationDate: string;
+  modificationDate: string | null;
+  email: string | null;
+};
+
+/** @internal */
+export const Comment$outboundSchema: z.ZodType<
+  Comment$Outbound,
+  z.ZodTypeDef,
+  Comment
+> = z.object({
+  id: z.string(),
+  auditEvidenceId: z.string(),
+  text: z.string(),
+  creationDate: z.date().transform(v => v.toISOString()),
+  modificationDate: z.nullable(z.date().transform(v => v.toISOString())),
+  email: z.nullable(z.string()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Comment$ {
+  /** @deprecated use `Comment$inboundSchema` instead. */
+  export const inboundSchema = Comment$inboundSchema;
+  /** @deprecated use `Comment$outboundSchema` instead. */
+  export const outboundSchema = Comment$outboundSchema;
+  /** @deprecated use `Comment$Outbound` instead. */
+  export type Outbound = Comment$Outbound;
+}
+
+export function commentToJSON(comment: Comment): string {
+  return JSON.stringify(Comment$outboundSchema.parse(comment));
+}
+
+export function commentFromJSON(
+  jsonString: string,
+): SafeParseResult<Comment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Comment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Comment' from JSON`,
+  );
+}