vanta-auditor-api-sdk 0.6.1 → 0.6.3

package/src/models/components/risksnapshot.ts

@@ -0,0 +1,48 @@
+/*
+ * 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";
+
+/**
+ * A risk assessment snapshot available for an audit.
+ *
+ * @remarks
+ *
+ * Risk snapshots capture the state of an organization's risk register at a
+ * point in time. Use the snapshot `id` with the `/audits/{auditId}/risks/{snapshotId}`
+ * endpoint to retrieve the risk scenarios within a snapshot.
+ */
+export type RiskSnapshot = {
+  /**
+   * Unique identifier for the risk snapshot.
+   */
+  id: string;
+  /**
+   * The date and time when this risk snapshot was created.
+   */
+  createdAt: Date;
+};
+
+/** @internal */
+export const RiskSnapshot$inboundSchema: z.ZodType<
+  RiskSnapshot,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+export function riskSnapshotFromJSON(
+  jsonString: string,
+): SafeParseResult<RiskSnapshot, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RiskSnapshot$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RiskSnapshot' from JSON`,
+  );
+}

package/src/models/components/vendororderby.ts

@@ -0,0 +1,17 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const VendorOrderBy = {
+  Name: "name",
+  InherentRisk: "inherentRisk",
+} as const;
+export type VendorOrderBy = ClosedEnum<typeof VendorOrderBy>;
+
+/** @internal */
+export const VendorOrderBy$outboundSchema: z.ZodNativeEnum<
+  typeof VendorOrderBy
+> = z.nativeEnum(VendorOrderBy);

package/src/models/operations/index.ts

@@ -15,18 +15,26 @@ export * from "./getaudit.js";
 export * from "./getframeworkcodes.js";
 export * from "./getinformationrequest.js";
 export * from "./getinformationrequesttestsnapshotevidencedetail.js";
+export * from "./listaccountaccessservices.js";
 export * from "./listauditcomments.js";
 export * from "./listauditcontrols.js";
 export * from "./listauditevidence.js";
 export * from "./listauditevidenceurls.js";
 export * from "./listauditissues.js";
+export * from "./listauditrisks.js";
 export * from "./listaudits.js";
 export * from "./listauditsnapshots.js";
+export * from "./listcodechanges.js";
 export * from "./listcommentsforinformationrequest.js";
 export * from "./listinformationrequestactivity.js";
 export * from "./listinformationrequestevidence.js";
 export * from "./listinformationrequests.js";
 export * from "./listinformationrequestsforcontrol.js";
+export * from "./listpersonnelaccountaccess.js";
+export * from "./listpersonnelgroups.js";
+export * from "./listpersonnelpeople.js";
+export * from "./listrisksnapshots.js";
+export * from "./listvendors.js";
 export * from "./shareinformationrequestlist.js";
 export * from "./updateauditevidence.js";
 export * from "./updatecommentforinformationrequest.js";

package/src/models/operations/listaccountaccessservices.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListAccountAccessServicesRequest = {
+  /**
+   * The audit ID
+   */
+  auditId: string;
+  /**
+   * Maximum number of results per page (1-100, default 10)
+   */
+  pageSize?: number | undefined;
+  /**
+   * Pagination cursor from previous response
+   */
+  pageCursor?: string | undefined;
+};
+
+/** @internal */
+export type ListAccountAccessServicesRequest$Outbound = {
+  auditId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+};
+
+/** @internal */
+export const ListAccountAccessServicesRequest$outboundSchema: z.ZodType<
+  ListAccountAccessServicesRequest$Outbound,
+  z.ZodTypeDef,
+  ListAccountAccessServicesRequest
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+});
+
+export function listAccountAccessServicesRequestToJSON(
+  listAccountAccessServicesRequest: ListAccountAccessServicesRequest,
+): string {
+  return JSON.stringify(
+    ListAccountAccessServicesRequest$outboundSchema.parse(
+      listAccountAccessServicesRequest,
+    ),
+  );
+}

package/src/models/operations/listauditissues.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod/v3";
+import * as components from "../components/index.js";
 
 export type ListAuditIssuesRequest = {
   /**
@@ -25,6 +26,14 @@ export type ListAuditIssuesRequest = {
    * Filter issues to specific snapshots by snapshot ID
    */
   snapshotIdMatchesAny?: Array<string> | undefined;
+  /**
+   * Field to sort results by. Allowed: "createdAt", "lastModifiedAt". Default: "createdAt"
+   */
+  orderBy?: components.IssueSnapshotItemOrderBy | undefined;
+  /**
+   * Sort direction: "asc" or "desc". Default: "desc"
+   */
+  orderDirection?: components.OrderDirection | undefined;
 };
 
 /** @internal */
@@ -34,6 +43,8 @@ export type ListAuditIssuesRequest$Outbound = {
   pageCursor?: string | undefined;
   search?: string | undefined;
   snapshotIdMatchesAny?: Array<string> | undefined;
+  orderBy?: string | undefined;
+  orderDirection?: string | undefined;
 };
 
 /** @internal */
@@ -47,6 +58,8 @@ export const ListAuditIssuesRequest$outboundSchema: z.ZodType<
   pageCursor: z.string().optional(),
   search: z.string().optional(),
   snapshotIdMatchesAny: z.array(z.string()).optional(),
+  orderBy: components.IssueSnapshotItemOrderBy$outboundSchema.optional(),
+  orderDirection: components.OrderDirection$outboundSchema.optional(),
 });
 
 export function listAuditIssuesRequestToJSON(

package/src/models/operations/listauditrisks.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+
+export type ListAuditRisksRequest = {
+  /**
+   * The audit ID
+   */
+  auditId: string;
+  /**
+   * The risk assessment snapshot ID
+   */
+  snapshotId: string;
+  /**
+   * Maximum number of results per page (1-100, default 10)
+   */
+  pageSize?: number | undefined;
+  /**
+   * Pagination cursor from previous response
+   */
+  pageCursor?: string | undefined;
+  /**
+   * Search term for filtering by risk scenario description
+   */
+  search?: string | undefined;
+  /**
+   * Field to sort results by. Allowed: "riskId", "riskScenario", "inherentRisk", "treatment", "residualRisk", "reviewStatus", "owner", "categories", "ciaCategories", "identified". Default: "identified"
+   */
+  orderBy?: components.RiskOrderBy | undefined;
+  /**
+   * Sort direction: "asc" or "desc". Default: "desc"
+   */
+  orderDirection?: components.OrderDirection | undefined;
+};
+
+/** @internal */
+export type ListAuditRisksRequest$Outbound = {
+  auditId: string;
+  snapshotId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+  search?: string | undefined;
+  orderBy?: string | undefined;
+  orderDirection?: string | undefined;
+};
+
+/** @internal */
+export const ListAuditRisksRequest$outboundSchema: z.ZodType<
+  ListAuditRisksRequest$Outbound,
+  z.ZodTypeDef,
+  ListAuditRisksRequest
+> = z.object({
+  auditId: z.string(),
+  snapshotId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  search: z.string().optional(),
+  orderBy: components.RiskOrderBy$outboundSchema.optional(),
+  orderDirection: components.OrderDirection$outboundSchema.optional(),
+});
+
+export function listAuditRisksRequestToJSON(
+  listAuditRisksRequest: ListAuditRisksRequest,
+): string {
+  return JSON.stringify(
+    ListAuditRisksRequest$outboundSchema.parse(listAuditRisksRequest),
+  );
+}

package/src/models/operations/listcodechanges.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+
+export type ListCodeChangesRequest = {
+  /**
+   * The audit ID
+   */
+  auditId: string;
+  /**
+   * Maximum number of results per page (1-100, default 10)
+   */
+  pageSize?: number | undefined;
+  /**
+   * Pagination cursor from previous response
+   */
+  pageCursor?: string | undefined;
+  /**
+   * Search term for filtering by code change title or repository name
+   */
+  search?: string | undefined;
+  /**
+   * Filter code changes by version control source (accepted values: github, gitlab, bitbucket, azuredevops)
+   */
+  sourcesMatchesAny?: Array<components.ApiCodeChangeSource> | undefined;
+  /**
+   * Filter code changes closed on or after this date (ISO 8601)
+   */
+  startDate?: Date | undefined;
+  /**
+   * Filter code changes closed on or before this date (ISO 8601)
+   */
+  endDate?: Date | undefined;
+};
+
+/** @internal */
+export type ListCodeChangesRequest$Outbound = {
+  auditId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+  search?: string | undefined;
+  sourcesMatchesAny?: Array<string> | undefined;
+  startDate?: string | undefined;
+  endDate?: string | undefined;
+};
+
+/** @internal */
+export const ListCodeChangesRequest$outboundSchema: z.ZodType<
+  ListCodeChangesRequest$Outbound,
+  z.ZodTypeDef,
+  ListCodeChangesRequest
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  search: z.string().optional(),
+  sourcesMatchesAny: z.array(components.ApiCodeChangeSource$outboundSchema)
+    .optional(),
+  startDate: z.date().transform(v => v.toISOString()).optional(),
+  endDate: z.date().transform(v => v.toISOString()).optional(),
+});
+
+export function listCodeChangesRequestToJSON(
+  listCodeChangesRequest: ListCodeChangesRequest,
+): string {
+  return JSON.stringify(
+    ListCodeChangesRequest$outboundSchema.parse(listCodeChangesRequest),
+  );
+}

package/src/models/operations/listpersonnelaccountaccess.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+
+export type ListPersonnelAccountAccessRequest = {
+  /**
+   * The audit ID
+   */
+  auditId: string;
+  /**
+   * The service ID from the /services endpoint
+   */
+  serviceId: string;
+  /**
+   * Maximum number of results per page (1-100, default 10)
+   */
+  pageSize?: number | undefined;
+  /**
+   * Pagination cursor from previous response
+   */
+  pageCursor?: string | undefined;
+  /**
+   * Search term for filtering by account name or email
+   */
+  search?: string | undefined;
+  /**
+   * Filter by account status
+   */
+  status?: components.AccountAccessStatus | undefined;
+};
+
+/** @internal */
+export type ListPersonnelAccountAccessRequest$Outbound = {
+  auditId: string;
+  serviceId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+  search?: string | undefined;
+  status?: string | undefined;
+};
+
+/** @internal */
+export const ListPersonnelAccountAccessRequest$outboundSchema: z.ZodType<
+  ListPersonnelAccountAccessRequest$Outbound,
+  z.ZodTypeDef,
+  ListPersonnelAccountAccessRequest
+> = z.object({
+  auditId: z.string(),
+  serviceId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  search: z.string().optional(),
+  status: components.AccountAccessStatus$outboundSchema.optional(),
+});
+
+export function listPersonnelAccountAccessRequestToJSON(
+  listPersonnelAccountAccessRequest: ListPersonnelAccountAccessRequest,
+): string {
+  return JSON.stringify(
+    ListPersonnelAccountAccessRequest$outboundSchema.parse(
+      listPersonnelAccountAccessRequest,
+    ),
+  );
+}

package/src/models/operations/listpersonnelgroups.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+
+export type ListPersonnelGroupsRequest = {
+  /**
+   * The audit ID
+   */
+  auditId: string;
+  /**
+   * Maximum number of results per page (1-100, default 10)
+   */
+  pageSize?: number | undefined;
+  /**
+   * Pagination cursor from previous response
+   */
+  pageCursor?: string | undefined;
+  /**
+   * Search term for filtering by group name
+   */
+  search?: string | undefined;
+  /**
+   * Filter groups by IDP source service names
+   */
+  sourcesMatchesAny?: Array<string> | undefined;
+  /**
+   * Field to sort results by. Allowed: "name", "members", "source", "tasksLastUpdated", "pointOfContact". Default: "name"
+   */
+  orderBy?: components.GroupOrderBy | undefined;
+  /**
+   * Sort direction: "asc" or "desc". Default: "asc"
+   */
+  orderDirection?: components.OrderDirection | undefined;
+};
+
+/** @internal */
+export type ListPersonnelGroupsRequest$Outbound = {
+  auditId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+  search?: string | undefined;
+  sourcesMatchesAny?: Array<string> | undefined;
+  orderBy?: string | undefined;
+  orderDirection?: string | undefined;
+};
+
+/** @internal */
+export const ListPersonnelGroupsRequest$outboundSchema: z.ZodType<
+  ListPersonnelGroupsRequest$Outbound,
+  z.ZodTypeDef,
+  ListPersonnelGroupsRequest
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  search: z.string().optional(),
+  sourcesMatchesAny: z.array(z.string()).optional(),
+  orderBy: components.GroupOrderBy$outboundSchema.optional(),
+  orderDirection: components.OrderDirection$outboundSchema.optional(),
+});
+
+export function listPersonnelGroupsRequestToJSON(
+  listPersonnelGroupsRequest: ListPersonnelGroupsRequest,
+): string {
+  return JSON.stringify(
+    ListPersonnelGroupsRequest$outboundSchema.parse(listPersonnelGroupsRequest),
+  );
+}

package/src/models/operations/listpersonnelpeople.ts

@@ -0,0 +1,77 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+
+export type ListPersonnelPeopleRequest = {
+  /**
+   * The audit ID
+   */
+  auditId: string;
+  /**
+   * Maximum number of results per page (1-100, default 10)
+   */
+  pageSize?: number | undefined;
+  /**
+   * Pagination cursor from previous response
+   */
+  pageCursor?: string | undefined;
+  /**
+   * Search term for filtering by name or email
+   */
+  search?: string | undefined;
+  /**
+   * Employment status filter
+   */
+  status?: components.PeopleEmploymentStatus | undefined;
+  /**
+   * Filter people by group IDs
+   */
+  groupsMatchesAny?: Array<string> | undefined;
+  /**
+   * Field to sort results by. Allowed: "name", "employmentStatus". Default: "name"
+   */
+  orderBy?: components.PeopleOrderBy | undefined;
+  /**
+   * Sort direction: "asc" or "desc". Default: "asc"
+   */
+  orderDirection?: components.OrderDirection | undefined;
+};
+
+/** @internal */
+export type ListPersonnelPeopleRequest$Outbound = {
+  auditId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+  search?: string | undefined;
+  status?: string | undefined;
+  groupsMatchesAny?: Array<string> | undefined;
+  orderBy?: string | undefined;
+  orderDirection?: string | undefined;
+};
+
+/** @internal */
+export const ListPersonnelPeopleRequest$outboundSchema: z.ZodType<
+  ListPersonnelPeopleRequest$Outbound,
+  z.ZodTypeDef,
+  ListPersonnelPeopleRequest
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  search: z.string().optional(),
+  status: components.PeopleEmploymentStatus$outboundSchema.optional(),
+  groupsMatchesAny: z.array(z.string()).optional(),
+  orderBy: components.PeopleOrderBy$outboundSchema.optional(),
+  orderDirection: components.OrderDirection$outboundSchema.optional(),
+});
+
+export function listPersonnelPeopleRequestToJSON(
+  listPersonnelPeopleRequest: ListPersonnelPeopleRequest,
+): string {
+  return JSON.stringify(
+    ListPersonnelPeopleRequest$outboundSchema.parse(listPersonnelPeopleRequest),
+  );
+}

package/src/models/operations/listrisksnapshots.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type ListRiskSnapshotsRequest = {
+  /**
+   * The audit ID
+   */
+  auditId: string;
+  /**
+   * Maximum number of results per page (1-100, default 10)
+   */
+  pageSize?: number | undefined;
+  /**
+   * Pagination cursor from previous response
+   */
+  pageCursor?: string | undefined;
+};
+
+/** @internal */
+export type ListRiskSnapshotsRequest$Outbound = {
+  auditId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+};
+
+/** @internal */
+export const ListRiskSnapshotsRequest$outboundSchema: z.ZodType<
+  ListRiskSnapshotsRequest$Outbound,
+  z.ZodTypeDef,
+  ListRiskSnapshotsRequest
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+});
+
+export function listRiskSnapshotsRequestToJSON(
+  listRiskSnapshotsRequest: ListRiskSnapshotsRequest,
+): string {
+  return JSON.stringify(
+    ListRiskSnapshotsRequest$outboundSchema.parse(listRiskSnapshotsRequest),
+  );
+}

package/src/models/operations/listvendors.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+
+export type ListVendorsRequest = {
+  /**
+   * The audit ID
+   */
+  auditId: string;
+  /**
+   * Maximum number of results per page (1-100, default 10)
+   */
+  pageSize?: number | undefined;
+  /**
+   * Pagination cursor from previous response
+   */
+  pageCursor?: string | undefined;
+  /**
+   * Search term for filtering by vendor name
+   */
+  search?: string | undefined;
+  /**
+   * Filter vendors by status values
+   */
+  vendorStatusesMatchesAny?: Array<components.AuditVendorStatus> | undefined;
+  /**
+   * Filter vendors by inherent risk level values
+   */
+  inherentRiskMatchesAny?: Array<components.AuditVendorRiskLevel> | undefined;
+  /**
+   * Field to sort results by. Allowed: "name", "inherentRisk". Default: "name"
+   */
+  orderBy?: components.VendorOrderBy | undefined;
+  /**
+   * Sort direction: "asc" or "desc". Default: "asc"
+   */
+  orderDirection?: components.OrderDirection | undefined;
+};
+
+/** @internal */
+export type ListVendorsRequest$Outbound = {
+  auditId: string;
+  pageSize: number;
+  pageCursor?: string | undefined;
+  search?: string | undefined;
+  vendorStatusesMatchesAny?: Array<string> | undefined;
+  inherentRiskMatchesAny?: Array<string> | undefined;
+  orderBy?: string | undefined;
+  orderDirection?: string | undefined;
+};
+
+/** @internal */
+export const ListVendorsRequest$outboundSchema: z.ZodType<
+  ListVendorsRequest$Outbound,
+  z.ZodTypeDef,
+  ListVendorsRequest
+> = z.object({
+  auditId: z.string(),
+  pageSize: z.number().int().default(10),
+  pageCursor: z.string().optional(),
+  search: z.string().optional(),
+  vendorStatusesMatchesAny: z.array(components.AuditVendorStatus$outboundSchema)
+    .optional(),
+  inherentRiskMatchesAny: z.array(
+    components.AuditVendorRiskLevel$outboundSchema,
+  ).optional(),
+  orderBy: components.VendorOrderBy$outboundSchema.optional(),
+  orderDirection: components.OrderDirection$outboundSchema.optional(),
+});
+
+export function listVendorsRequestToJSON(
+  listVendorsRequest: ListVendorsRequest,
+): string {
+  return JSON.stringify(
+    ListVendorsRequest$outboundSchema.parse(listVendorsRequest),
+  );
+}