vanta-auditor-api-sdk 0.6.1 → 0.6.3

package/src/models/components/auditrisk.ts

@@ -0,0 +1,216 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { AuditRiskCia, AuditRiskCia$inboundSchema } from "./auditriskcia.js";
+
+/**
+ * Risk treatment strategy, or null if not set.
+ */
+export const Treatment = {
+  Accept: "ACCEPT",
+  Avoid: "AVOID",
+  Mitigate: "MITIGATE",
+  Transfer: "TRANSFER",
+} as const;
+/**
+ * Risk treatment strategy, or null if not set.
+ */
+export type Treatment = ClosedEnum<typeof Treatment>;
+
+/**
+ * Treatment implementation status, or null if not set.
+ */
+export const TreatmentStatus = {
+  InProgress: "IN_PROGRESS",
+  Done: "DONE",
+} as const;
+/**
+ * Treatment implementation status, or null if not set.
+ */
+export type TreatmentStatus = ClosedEnum<typeof TreatmentStatus>;
+
+/**
+ * Review status of the risk scenario, or null if not set.
+ */
+export const ReviewStatus = {
+  Approved: "APPROVED",
+  Draft: "DRAFT",
+  NotReviewed: "NOT_REVIEWED",
+  AwaitingSubmission: "AWAITING_SUBMISSION",
+  PendingApproval: "PENDING_APPROVAL",
+  RequestedChanges: "REQUESTED_CHANGES",
+} as const;
+/**
+ * Review status of the risk scenario, or null if not set.
+ */
+export type ReviewStatus = ClosedEnum<typeof ReviewStatus>;
+
+/**
+ * Risk owner information, or null if no owner assigned.
+ */
+export type AuditRiskOwner = {
+  /**
+   * Display name of the risk owner.
+   */
+  displayName: string;
+  /**
+   * URL of the owner's profile image, or null if not available.
+   */
+  imageUrl: string | null;
+};
+
+/**
+ * A risk record from the risk population.
+ *
+ * @remarks
+ *
+ * `id` and `riskId` are required. All other fields are optional to support customizable field visibility.
+ *
+ * Omitted keys mean the column is not in the response; `null` means the column is present but empty.
+ */
+export type AuditRisk = {
+  /**
+   * Unique identifier for the risk scenario version.
+   */
+  id: string;
+  /**
+   * Custom risk ID (e.g., "RISK-001"), or null if not available.
+   */
+  riskId: string | null;
+  /**
+   * Description of the risk scenario, or null if not available.
+   */
+  riskScenario?: string | null | undefined;
+  /**
+   * Likelihood score of the risk, or null if not scored.
+   *
+   * @remarks
+   * Full Audit View only - omitted in Controlled Audit View.
+   */
+  likelihood?: number | null | undefined;
+  /**
+   * Impact score of the risk, or null if not scored.
+   *
+   * @remarks
+   * Full Audit View only - omitted in Controlled Audit View.
+   */
+  impact?: number | null | undefined;
+  /**
+   * Inherent risk score (likelihood * impact), or null if not calculable.
+   */
+  inherentRisk?: number | null | undefined;
+  /**
+   * Risk treatment strategy, or null if not set.
+   */
+  treatment?: Treatment | null | undefined;
+  /**
+   * Treatment implementation status, or null if not set.
+   */
+  treatmentStatus?: TreatmentStatus | null | undefined;
+  /**
+   * Residual risk score after treatment, or null if not calculable.
+   */
+  residualRisk?: number | null | undefined;
+  /**
+   * Review status of the risk scenario, or null if not set.
+   */
+  reviewStatus?: ReviewStatus | null | undefined;
+  /**
+   * Risk owner information, or null if no owner assigned.
+   */
+  owner?: AuditRiskOwner | null | undefined;
+  /**
+   * Risk category names, or empty array if not categorized.
+   */
+  categories?: Array<string> | undefined;
+  /**
+   * CIA triad categories, or empty array if not categorized.
+   */
+  ciaCategories?: Array<AuditRiskCia> | undefined;
+  /**
+   * IDs of controls linked to this risk scenario, or empty array if none.
+   *
+   * @remarks
+   * Full Audit View only - omitted in Controlled Audit View.
+   */
+  linkedControlIds?: Array<string> | undefined;
+  /**
+   * When the risk was identified, or null if not recorded.
+   *
+   * @remarks
+   * ISO 8601 format.
+   */
+  identified?: string | null | undefined;
+};
+
+/** @internal */
+export const Treatment$inboundSchema: z.ZodNativeEnum<typeof Treatment> = z
+  .nativeEnum(Treatment);
+
+/** @internal */
+export const TreatmentStatus$inboundSchema: z.ZodNativeEnum<
+  typeof TreatmentStatus
+> = z.nativeEnum(TreatmentStatus);
+
+/** @internal */
+export const ReviewStatus$inboundSchema: z.ZodNativeEnum<typeof ReviewStatus> =
+  z.nativeEnum(ReviewStatus);
+
+/** @internal */
+export const AuditRiskOwner$inboundSchema: z.ZodType<
+  AuditRiskOwner,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  displayName: z.string(),
+  imageUrl: z.nullable(z.string()),
+});
+
+export function auditRiskOwnerFromJSON(
+  jsonString: string,
+): SafeParseResult<AuditRiskOwner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuditRiskOwner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuditRiskOwner' from JSON`,
+  );
+}
+
+/** @internal */
+export const AuditRisk$inboundSchema: z.ZodType<
+  AuditRisk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  riskId: z.nullable(z.string()),
+  riskScenario: z.nullable(z.string()).optional(),
+  likelihood: z.nullable(z.number()).optional(),
+  impact: z.nullable(z.number()).optional(),
+  inherentRisk: z.nullable(z.number()).optional(),
+  treatment: z.nullable(Treatment$inboundSchema).optional(),
+  treatmentStatus: z.nullable(TreatmentStatus$inboundSchema).optional(),
+  residualRisk: z.nullable(z.number()).optional(),
+  reviewStatus: z.nullable(ReviewStatus$inboundSchema).optional(),
+  owner: z.nullable(z.lazy(() => AuditRiskOwner$inboundSchema)).optional(),
+  categories: z.array(z.string()).optional(),
+  ciaCategories: z.array(AuditRiskCia$inboundSchema).optional(),
+  linkedControlIds: z.array(z.string()).optional(),
+  identified: z.nullable(z.string()).optional(),
+});
+
+export function auditRiskFromJSON(
+  jsonString: string,
+): SafeParseResult<AuditRisk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuditRisk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuditRisk' from JSON`,
+  );
+}

package/src/models/components/auditriskcia.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * CIA triad category returned by the auditor API.
+ */
+export const AuditRiskCia = {
+  Availability: "AVAILABILITY",
+  Confidentiality: "CONFIDENTIALITY",
+  Integrity: "INTEGRITY",
+} as const;
+/**
+ * CIA triad category returned by the auditor API.
+ */
+export type AuditRiskCia = ClosedEnum<typeof AuditRiskCia>;
+
+/** @internal */
+export const AuditRiskCia$inboundSchema: z.ZodNativeEnum<typeof AuditRiskCia> =
+  z.nativeEnum(AuditRiskCia);

package/src/models/components/auditvendor.ts

@@ -0,0 +1,158 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AuditVendorRiskLevel,
+  AuditVendorRiskLevel$inboundSchema,
+} from "./auditvendorrisklevel.js";
+import {
+  AuditVendorStatus,
+  AuditVendorStatus$inboundSchema,
+} from "./auditvendorstatus.js";
+
+/**
+ * Residual risk level of the vendor.
+ *
+ * @remarks
+ * Full Audit View only - omitted in Controlled Audit View.
+ */
+export const ResidualRisk = {
+  Critical: "CRITICAL",
+  High: "HIGH",
+  Medium: "MEDIUM",
+  Low: "LOW",
+  Unscored: "UNSCORED",
+} as const;
+/**
+ * Residual risk level of the vendor.
+ *
+ * @remarks
+ * Full Audit View only - omitted in Controlled Audit View.
+ */
+export type ResidualRisk = ClosedEnum<typeof ResidualRisk>;
+
+/**
+ * BAA/DPA document completion counts, or null if no such documents are required.
+ *
+ * @remarks
+ * Full Audit View only - omitted in Controlled Audit View.
+ */
+export type DataAgreements = {
+  total: number;
+  complete: number;
+};
+
+/**
+ * Managed vendor row returned by the auditor managed-vendors API.
+ *
+ * @remarks
+ *
+ * Only `id` and `name` are required. All other fields are optional to support
+ * controlled audits where only approved columns are returned and
+ * customizable field visibility.
+ */
+export type AuditVendor = {
+  /**
+   * Vendor record ID.
+   */
+  id: string;
+  /**
+   * Vendor name.
+   */
+  name: string;
+  inherentRisk?: AuditVendorRiskLevel | undefined;
+  status?: AuditVendorStatus | undefined;
+  /**
+   * Number of findings associated with the vendor.
+   */
+  findings?: number | undefined;
+  /**
+   * Date when the last security review was completed, or null if none.
+   */
+  lastReviewedCompleted?: Date | null | undefined;
+  /**
+   * Date when the next security review is due, or null if not scheduled.
+   */
+  nextSecurityReviewDueDate?: Date | null | undefined;
+  /**
+   * Vendor category (e.g. cloud provider, SaaS).
+   */
+  vendorCategory?: string | null | undefined;
+  /**
+   * Residual risk level of the vendor.
+   *
+   * @remarks
+   * Full Audit View only - omitted in Controlled Audit View.
+   */
+  residualRisk?: ResidualRisk | null | undefined;
+  /**
+   * BAA/DPA document completion counts, or null if no such documents are required.
+   *
+   * @remarks
+   * Full Audit View only - omitted in Controlled Audit View.
+   */
+  dataAgreements?: DataAgreements | null | undefined;
+};
+
+/** @internal */
+export const ResidualRisk$inboundSchema: z.ZodNativeEnum<typeof ResidualRisk> =
+  z.nativeEnum(ResidualRisk);
+
+/** @internal */
+export const DataAgreements$inboundSchema: z.ZodType<
+  DataAgreements,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total: z.number(),
+  complete: z.number(),
+});
+
+export function dataAgreementsFromJSON(
+  jsonString: string,
+): SafeParseResult<DataAgreements, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DataAgreements$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DataAgreements' from JSON`,
+  );
+}
+
+/** @internal */
+export const AuditVendor$inboundSchema: z.ZodType<
+  AuditVendor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+  inherentRisk: AuditVendorRiskLevel$inboundSchema.optional(),
+  status: AuditVendorStatus$inboundSchema.optional(),
+  findings: z.number().optional(),
+  lastReviewedCompleted: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  nextSecurityReviewDueDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  vendorCategory: z.nullable(z.string()).optional(),
+  residualRisk: z.nullable(ResidualRisk$inboundSchema).optional(),
+  dataAgreements: z.nullable(z.lazy(() => DataAgreements$inboundSchema))
+    .optional(),
+});
+
+export function auditVendorFromJSON(
+  jsonString: string,
+): SafeParseResult<AuditVendor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuditVendor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuditVendor' from JSON`,
+  );
+}

package/src/models/components/auditvendorrisklevel.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const AuditVendorRiskLevel = {
+  Critical: "CRITICAL",
+  High: "HIGH",
+  Medium: "MEDIUM",
+  Low: "LOW",
+  Unscored: "UNSCORED",
+} as const;
+export type AuditVendorRiskLevel = ClosedEnum<typeof AuditVendorRiskLevel>;
+
+/** @internal */
+export const AuditVendorRiskLevel$inboundSchema: z.ZodNativeEnum<
+  typeof AuditVendorRiskLevel
+> = z.nativeEnum(AuditVendorRiskLevel);
+/** @internal */
+export const AuditVendorRiskLevel$outboundSchema: z.ZodNativeEnum<
+  typeof AuditVendorRiskLevel
+> = AuditVendorRiskLevel$inboundSchema;

package/src/models/components/auditvendorstatus.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const AuditVendorStatus = {
+  Active: "ACTIVE",
+  Archived: "ARCHIVED",
+  InProcurement: "IN_PROCUREMENT",
+} as const;
+export type AuditVendorStatus = ClosedEnum<typeof AuditVendorStatus>;
+
+/** @internal */
+export const AuditVendorStatus$inboundSchema: z.ZodNativeEnum<
+  typeof AuditVendorStatus
+> = z.nativeEnum(AuditVendorStatus);
+/** @internal */
+export const AuditVendorStatus$outboundSchema: z.ZodNativeEnum<
+  typeof AuditVendorStatus
+> = AuditVendorStatus$inboundSchema;

package/src/models/components/codechange.ts

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+
+/**
+ * Code change data.
+ *
+ * @remarks
+ *
+ * `id` and `codeChange` are required. All other fields are optional to support customizable field visibility.
+ *
+ * Omitted keys mean the column is not in the response; `null` means the column is present but empty.
+ */
+export type CodeChange = {
+  /**
+   * Code change record ID - always present.
+   */
+  id: string;
+  /**
+   * Code change title (e.g. PR title) - always present.
+   */
+  codeChange: string;
+  /**
+   * Code change identifier (e.g. PR number).
+   */
+  identifier?: string | undefined;
+  /**
+   * Version control source where the change originated.
+   *
+   * @remarks
+   * Known values are listed in {@link ApiCodeChangeSource}; other strings may
+   * appear if a new source is onboarded before this enum is updated.
+   */
+  service?: string | undefined;
+  /**
+   * Repository name.
+   */
+  repository?: string | undefined;
+  /**
+   * Date the code change was opened.
+   */
+  openedAt?: Date | undefined;
+  /**
+   * Date the code change was merged/closed.
+   */
+  closedAt?: Date | undefined;
+};
+
+/** @internal */
+export const CodeChange$inboundSchema: z.ZodType<
+  CodeChange,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  codeChange: z.string(),
+  identifier: z.string().optional(),
+  service: z.string().optional(),
+  repository: z.string().optional(),
+  openedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  closedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+});
+
+export function codeChangeFromJSON(
+  jsonString: string,
+): SafeParseResult<CodeChange, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CodeChange$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CodeChange' from JSON`,
+  );
+}

package/src/models/components/grouporderby.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const GroupOrderBy = {
+  Name: "name",
+  Members: "members",
+  Source: "source",
+  TasksLastUpdated: "tasksLastUpdated",
+  PointOfContact: "pointOfContact",
+} as const;
+export type GroupOrderBy = ClosedEnum<typeof GroupOrderBy>;
+
+/** @internal */
+export const GroupOrderBy$outboundSchema: z.ZodNativeEnum<typeof GroupOrderBy> =
+  z.nativeEnum(GroupOrderBy);

package/src/models/components/index.ts

@@ -3,9 +3,13 @@
  */
 
 export * from "./acceptinformationrequestevidenceinput.js";
+export * from "./accountaccess.js";
+export * from "./accountaccessservice.js";
+export * from "./accountaccessstatus.js";
 export * from "./addauditorinput.js";
 export * from "./addcommentinput.js";
 export * from "./addinformationrequestcommentinput.js";
+export * from "./apicodechangesource.js";
 export * from "./audit.js";
 export * from "./auditevidencestate.js";
 export * from "./auditevidencetype.js";
@@ -14,6 +18,12 @@ export * from "./auditfocus.js";
 export * from "./auditor.js";
 export * from "./auditorcontrol.js";
 export * from "./auditorenabledstatetransition.js";
+export * from "./auditrisk.js";
+export * from "./auditriskcia.js";
+export * from "./auditvendor.js";
+export * from "./auditvendorrisklevel.js";
+export * from "./auditvendorstatus.js";
+export * from "./codechange.js";
 export * from "./comment.js";
 export * from "./control.js";
 export * from "./controldomain.js";
@@ -31,6 +41,7 @@ export * from "./flaginformationrequestevidenceinput.js";
 export * from "./frameworkcodes.js";
 export * from "./frameworkid.js";
 export * from "./frameworksection.js";
+export * from "./grouporderby.js";
 export * from "./informationrequest.js";
 export * from "./informationrequestactivitylog.js";
 export * from "./informationrequestactivitytype.js";
@@ -42,15 +53,22 @@ export * from "./informationrequestevidenceunion.js";
 export * from "./informationrequestsupportedevidencetype.js";
 export * from "./informationrequesttype.js";
 export * from "./issuesnapshotitem.js";
+export * from "./issuesnapshotitemorderby.js";
 export * from "./issuesnapshotmetadata.js";
 export * from "./issuestatustypeforsnapshot.js";
 export * from "./linkevidence.js";
 export * from "./observationevidence.js";
+export * from "./orderdirection.js";
 export * from "./pageinfo.js";
 export * from "./paginatedissuesnapshotitemsresponse.js";
 export * from "./paginatedissuesnapshotmetadataresponse.js";
+export * from "./paginatedresponseaccountaccess.js";
+export * from "./paginatedresponseaccountaccessservice.js";
 export * from "./paginatedresponseaudit.js";
 export * from "./paginatedresponseauditorcontrol.js";
+export * from "./paginatedresponseauditrisk.js";
+export * from "./paginatedresponseauditvendor.js";
+export * from "./paginatedresponsecodechange.js";
 export * from "./paginatedresponsecomment.js";
 export * from "./paginatedresponseevidence.js";
 export * from "./paginatedresponseevidenceurl.js";
@@ -58,8 +76,20 @@ export * from "./paginatedresponseinformationrequest.js";
 export * from "./paginatedresponseinformationrequestactivitylog.js";
 export * from "./paginatedresponseinformationrequestcomment.js";
 export * from "./paginatedresponseinformationrequestevidence.js";
+export * from "./paginatedresponsepersonnelgroup.js";
+export * from "./paginatedresponsepersonnelperson.js";
+export * from "./paginatedresponserisksnapshot.js";
 export * from "./partialupdateinformationrequest.js";
+export * from "./peopleemploymentstatus.js";
+export * from "./peopleorderby.js";
+export * from "./peoplesecuritytaskstatus.js";
+export * from "./peopletaskstatus.js";
+export * from "./personnelgroup.js";
+export * from "./personnelgrouptask.js";
+export * from "./personnelperson.js";
 export * from "./recurrenceduration.js";
+export * from "./riskorderby.js";
+export * from "./risksnapshot.js";
 export * from "./section.js";
 export * from "./security.js";
 export * from "./updateinformationrequestcommentinput.js";
@@ -75,3 +105,4 @@ export * from "./vantatestsnapshotevidence.js";
 export * from "./vantatestsnapshotevidencedetail.js";
 export * from "./vantatestsnapshotintegration.js";
 export * from "./vantatestsnapshotrawtestdatarow.js";
+export * from "./vendororderby.js";

package/src/models/components/issuesnapshotitemorderby.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Allowed values for the `orderBy` query parameter on issue snapshot item endpoints.
+ */
+export const IssueSnapshotItemOrderBy = {
+  CreatedAt: "createdAt",
+  LastModifiedAt: "lastModifiedAt",
+} as const;
+/**
+ * Allowed values for the `orderBy` query parameter on issue snapshot item endpoints.
+ */
+export type IssueSnapshotItemOrderBy = ClosedEnum<
+  typeof IssueSnapshotItemOrderBy
+>;
+
+/** @internal */
+export const IssueSnapshotItemOrderBy$outboundSchema: z.ZodNativeEnum<
+  typeof IssueSnapshotItemOrderBy
+> = z.nativeEnum(IssueSnapshotItemOrderBy);

package/src/models/components/orderdirection.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Sort direction: "asc" for ascending, "desc" for descending.
+ */
+export const OrderDirection = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * Sort direction: "asc" for ascending, "desc" for descending.
+ */
+export type OrderDirection = ClosedEnum<typeof OrderDirection>;
+
+/** @internal */
+export const OrderDirection$outboundSchema: z.ZodNativeEnum<
+  typeof OrderDirection
+> = z.nativeEnum(OrderDirection);