vanta-auditor-api-sdk 0.6.3 → 0.6.4

package/src/models/components/paginatedresponseperson.ts

@@ -0,0 +1,61 @@
+/*
+ * 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";
+import { PageInfo, PageInfo$inboundSchema } from "./pageinfo.js";
+import { Person, Person$inboundSchema } from "./person.js";
+
+export type PaginatedResponsePersonResults = {
+  data: Array<Person>;
+  /**
+   * Provides information about the pagination of a dataset.
+   */
+  pageInfo: PageInfo;
+};
+
+export type PaginatedResponsePerson = {
+  results: PaginatedResponsePersonResults;
+};
+
+/** @internal */
+export const PaginatedResponsePersonResults$inboundSchema: z.ZodType<
+  PaginatedResponsePersonResults,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(Person$inboundSchema),
+  pageInfo: PageInfo$inboundSchema,
+});
+
+export function paginatedResponsePersonResultsFromJSON(
+  jsonString: string,
+): SafeParseResult<PaginatedResponsePersonResults, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaginatedResponsePersonResults$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaginatedResponsePersonResults' from JSON`,
+  );
+}
+
+/** @internal */
+export const PaginatedResponsePerson$inboundSchema: z.ZodType<
+  PaginatedResponsePerson,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  results: z.lazy(() => PaginatedResponsePersonResults$inboundSchema),
+});
+
+export function paginatedResponsePersonFromJSON(
+  jsonString: string,
+): SafeParseResult<PaginatedResponsePerson, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaginatedResponsePerson$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaginatedResponsePerson' from JSON`,
+  );
+}

package/src/models/components/paginatedresponsevendor.ts

@@ -0,0 +1,61 @@
+/*
+ * 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";
+import { PageInfo, PageInfo$inboundSchema } from "./pageinfo.js";
+import { Vendor, Vendor$inboundSchema } from "./vendor.js";
+
+export type PaginatedResponseVendorResults = {
+  data: Array<Vendor>;
+  /**
+   * Provides information about the pagination of a dataset.
+   */
+  pageInfo: PageInfo;
+};
+
+export type PaginatedResponseVendor = {
+  results: PaginatedResponseVendorResults;
+};
+
+/** @internal */
+export const PaginatedResponseVendorResults$inboundSchema: z.ZodType<
+  PaginatedResponseVendorResults,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(Vendor$inboundSchema),
+  pageInfo: PageInfo$inboundSchema,
+});
+
+export function paginatedResponseVendorResultsFromJSON(
+  jsonString: string,
+): SafeParseResult<PaginatedResponseVendorResults, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaginatedResponseVendorResults$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaginatedResponseVendorResults' from JSON`,
+  );
+}
+
+/** @internal */
+export const PaginatedResponseVendor$inboundSchema: z.ZodType<
+  PaginatedResponseVendor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  results: z.lazy(() => PaginatedResponseVendorResults$inboundSchema),
+});
+
+export function paginatedResponseVendorFromJSON(
+  jsonString: string,
+): SafeParseResult<PaginatedResponseVendor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaginatedResponseVendor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaginatedResponseVendor' from JSON`,
+  );
+}

package/src/models/components/paginatedresponsevulnerabilityremediation.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";
+import { PageInfo, PageInfo$inboundSchema } from "./pageinfo.js";
+import {
+  VulnerabilityRemediation,
+  VulnerabilityRemediation$inboundSchema,
+} from "./vulnerabilityremediation.js";
+
+export type PaginatedResponseVulnerabilityRemediationResults = {
+  data: Array<VulnerabilityRemediation>;
+  /**
+   * Provides information about the pagination of a dataset.
+   */
+  pageInfo: PageInfo;
+};
+
+export type PaginatedResponseVulnerabilityRemediation = {
+  results: PaginatedResponseVulnerabilityRemediationResults;
+};
+
+/** @internal */
+export const PaginatedResponseVulnerabilityRemediationResults$inboundSchema:
+  z.ZodType<
+    PaginatedResponseVulnerabilityRemediationResults,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    data: z.array(VulnerabilityRemediation$inboundSchema),
+    pageInfo: PageInfo$inboundSchema,
+  });
+
+export function paginatedResponseVulnerabilityRemediationResultsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PaginatedResponseVulnerabilityRemediationResults,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PaginatedResponseVulnerabilityRemediationResults$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PaginatedResponseVulnerabilityRemediationResults' from JSON`,
+  );
+}
+
+/** @internal */
+export const PaginatedResponseVulnerabilityRemediation$inboundSchema: z.ZodType<
+  PaginatedResponseVulnerabilityRemediation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  results: z.lazy(() =>
+    PaginatedResponseVulnerabilityRemediationResults$inboundSchema
+  ),
+});
+
+export function paginatedResponseVulnerabilityRemediationFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PaginatedResponseVulnerabilityRemediation,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PaginatedResponseVulnerabilityRemediation$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PaginatedResponseVulnerabilityRemediation' from JSON`,
+  );
+}

package/src/models/components/paginatedresponsevulnerableasset.ts

@@ -0,0 +1,70 @@
+/*
+ * 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";
+import { PageInfo, PageInfo$inboundSchema } from "./pageinfo.js";
+import {
+  VulnerableAsset,
+  VulnerableAsset$inboundSchema,
+} from "./vulnerableasset.js";
+
+export type PaginatedResponseVulnerableAssetResults = {
+  data: Array<VulnerableAsset>;
+  /**
+   * Provides information about the pagination of a dataset.
+   */
+  pageInfo: PageInfo;
+};
+
+export type PaginatedResponseVulnerableAsset = {
+  results: PaginatedResponseVulnerableAssetResults;
+};
+
+/** @internal */
+export const PaginatedResponseVulnerableAssetResults$inboundSchema: z.ZodType<
+  PaginatedResponseVulnerableAssetResults,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(VulnerableAsset$inboundSchema),
+  pageInfo: PageInfo$inboundSchema,
+});
+
+export function paginatedResponseVulnerableAssetResultsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PaginatedResponseVulnerableAssetResults,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PaginatedResponseVulnerableAssetResults$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PaginatedResponseVulnerableAssetResults' from JSON`,
+  );
+}
+
+/** @internal */
+export const PaginatedResponseVulnerableAsset$inboundSchema: z.ZodType<
+  PaginatedResponseVulnerableAsset,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  results: z.lazy(() => PaginatedResponseVulnerableAssetResults$inboundSchema),
+});
+
+export function paginatedResponseVulnerableAssetFromJSON(
+  jsonString: string,
+): SafeParseResult<PaginatedResponseVulnerableAsset, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaginatedResponseVulnerableAsset$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaginatedResponseVulnerableAsset' from JSON`,
+  );
+}

package/src/models/components/person.ts

@@ -0,0 +1,323 @@
+/*
+ * 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";
+import {
+  EmploymentStatus,
+  EmploymentStatus$inboundSchema,
+} from "./employmentstatus.js";
+import { LeaveStatus, LeaveStatus$inboundSchema } from "./leavestatus.js";
+import {
+  PersonInfoSource,
+  PersonInfoSource$inboundSchema,
+} from "./personinfosource.js";
+import {
+  TasksSummaryStatus,
+  TasksSummaryStatus$inboundSchema,
+} from "./taskssummarystatus.js";
+import {
+  TaskSummaryDetails,
+  TaskSummaryDetails$inboundSchema,
+} from "./tasksummarydetails.js";
+
+export type Employment = {
+  /**
+   * The employment status of a person:
+   *
+   * @remarks
+   * - UPCOMING: The person is not yet employed and will start employment in the future.
+   * - CURRENT: The person is currently employed.
+   * - ON_LEAVE: The person is on leave.
+   * - INACTIVE: The person's employment is inactive.
+   * - FORMER: The person was previously employed.
+   */
+  status: EmploymentStatus;
+  /**
+   * The date the person's employment started.
+   */
+  startDate: Date;
+  /**
+   * The person's job title.
+   */
+  jobTitle: string | null;
+  /**
+   * If present, the date the person's employment ended.
+   */
+  endDate: Date | null;
+};
+
+/**
+ * If present, the user's active/upcoming leave. Empty if the user has no active/upcoming leave.
+ */
+export type LeaveInfo = {
+  /**
+   * The start of the person's leave.
+   */
+  startDate: Date;
+  /**
+   * The end of the person's leave. Null endDate implies indefinite leave.
+   */
+  endDate: Date | null;
+  /**
+   * User can be active or upcoming leave period
+   */
+  status: LeaveStatus;
+};
+
+export type Name = {
+  /**
+   * The person's first (given) name.
+   */
+  first: string | null;
+  /**
+   * The person's last (family) name.
+   */
+  last: string | null;
+  /**
+   * The person's display name, used in Vanta.
+   */
+  display: string;
+};
+
+export type PersonEmployment = {
+  /**
+   * The source of the person's information.
+   */
+  endDate: PersonInfoSource;
+  /**
+   * The source of the person's information.
+   */
+  startDate: PersonInfoSource;
+};
+
+/**
+ * The sources of the person's information.
+ */
+export type Sources = {
+  employment: PersonEmployment;
+  /**
+   * The source of the person's information.
+   */
+  emailAddress: PersonInfoSource;
+};
+
+/**
+ * The person's tasks summary, which aggregates their current status across
+ *
+ * @remarks
+ * all of their relevant tasks.
+ */
+export type TasksSummary = {
+  /**
+   * All detailed information about a person's tasks, split across task categories.
+   */
+  details: TaskSummaryDetails;
+  /**
+   * The overall status of a person's outstanding tasks:
+   *
+   * @remarks
+   * - NONE: There are no tasks.
+   * - DUE_SOON: At least one task is due soon.
+   * - OVERDUE: At least one task is overdue. Has a higher priority than DUE_SOON.
+   * - COMPLETE: All tasks are complete.
+   * - PAUSED: All tasks are paused.
+   * - OFFBOARDING_DUE_SOON: At least one offboarding task is due soon.
+   * - OFFBOARDING_OVERDUE: At least one offboarding task is overdue. Has a higher priority than OFFBOARDING_DUE_SOON.
+   * - OFFBOARDING_COMPLETE: All offboarding tasks are complete.
+   */
+  status: TasksSummaryStatus;
+  /**
+   * The due date of the person's earliest-due task.
+   */
+  dueDate: Date | null;
+  /**
+   * The date when person's tasks were completed.
+   */
+  completionDate: Date | null;
+};
+
+export type Person = {
+  id: string;
+  /**
+   * The ID of the Vanta user account associated with this person, if one exists.
+   */
+  userId: string | null;
+  emailAddress: string;
+  employment: Employment;
+  /**
+   * If present, the user's active/upcoming leave. Empty if the user has no active/upcoming leave.
+   */
+  leaveInfo: LeaveInfo | null;
+  /**
+   * The id of each group the user belongs to. This includes both manually created groups in Vanta and groups imported from an identity provider.
+   */
+  groupIds: Array<string>;
+  name: Name;
+  /**
+   * The sources of the person's information.
+   */
+  sources: Sources;
+  /**
+   * The person's tasks summary, which aggregates their current status across
+   *
+   * @remarks
+   * all of their relevant tasks.
+   */
+  tasksSummary: TasksSummary;
+};
+
+/** @internal */
+export const Employment$inboundSchema: z.ZodType<
+  Employment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: EmploymentStatus$inboundSchema,
+  startDate: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  jobTitle: z.nullable(z.string()),
+  endDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+});
+
+export function employmentFromJSON(
+  jsonString: string,
+): SafeParseResult<Employment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Employment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Employment' from JSON`,
+  );
+}
+
+/** @internal */
+export const LeaveInfo$inboundSchema: z.ZodType<
+  LeaveInfo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  startDate: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  endDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  status: LeaveStatus$inboundSchema,
+});
+
+export function leaveInfoFromJSON(
+  jsonString: string,
+): SafeParseResult<LeaveInfo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LeaveInfo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LeaveInfo' from JSON`,
+  );
+}
+
+/** @internal */
+export const Name$inboundSchema: z.ZodType<Name, z.ZodTypeDef, unknown> = z
+  .object({
+    first: z.nullable(z.string()),
+    last: z.nullable(z.string()),
+    display: z.string(),
+  });
+
+export function nameFromJSON(
+  jsonString: string,
+): SafeParseResult<Name, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Name$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Name' from JSON`,
+  );
+}
+
+/** @internal */
+export const PersonEmployment$inboundSchema: z.ZodType<
+  PersonEmployment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  endDate: PersonInfoSource$inboundSchema,
+  startDate: PersonInfoSource$inboundSchema,
+});
+
+export function personEmploymentFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonEmployment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PersonEmployment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonEmployment' from JSON`,
+  );
+}
+
+/** @internal */
+export const Sources$inboundSchema: z.ZodType<Sources, z.ZodTypeDef, unknown> =
+  z.object({
+    employment: z.lazy(() => PersonEmployment$inboundSchema),
+    emailAddress: PersonInfoSource$inboundSchema,
+  });
+
+export function sourcesFromJSON(
+  jsonString: string,
+): SafeParseResult<Sources, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Sources$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Sources' from JSON`,
+  );
+}
+
+/** @internal */
+export const TasksSummary$inboundSchema: z.ZodType<
+  TasksSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  details: TaskSummaryDetails$inboundSchema,
+  status: TasksSummaryStatus$inboundSchema,
+  dueDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  completionDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+});
+
+export function tasksSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<TasksSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TasksSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TasksSummary' from JSON`,
+  );
+}
+
+/** @internal */
+export const Person$inboundSchema: z.ZodType<Person, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string(),
+    userId: z.nullable(z.string()),
+    emailAddress: z.string(),
+    employment: z.lazy(() => Employment$inboundSchema),
+    leaveInfo: z.nullable(z.lazy(() => LeaveInfo$inboundSchema)),
+    groupIds: z.array(z.string()),
+    name: z.lazy(() => Name$inboundSchema),
+    sources: z.lazy(() => Sources$inboundSchema),
+    tasksSummary: z.lazy(() => TasksSummary$inboundSchema),
+  });
+
+export function personFromJSON(
+  jsonString: string,
+): SafeParseResult<Person, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Person$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Person' from JSON`,
+  );
+}

package/src/models/components/personinfosource.ts

@@ -0,0 +1,49 @@
+/*
+ * 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";
+import {
+  IntegrationBasedPersonInfoSource,
+  IntegrationBasedPersonInfoSource$inboundSchema,
+} from "./integrationbasedpersoninfosource.js";
+import {
+  ScimBasedPersonInfoSource,
+  ScimBasedPersonInfoSource$inboundSchema,
+} from "./scimbasedpersoninfosource.js";
+import {
+  VantaBasedPersonInfoSource,
+  VantaBasedPersonInfoSource$inboundSchema,
+} from "./vantabasedpersoninfosource.js";
+
+/**
+ * The source of the person's information.
+ */
+export type PersonInfoSource =
+  | VantaBasedPersonInfoSource
+  | ScimBasedPersonInfoSource
+  | IntegrationBasedPersonInfoSource;
+
+/** @internal */
+export const PersonInfoSource$inboundSchema: z.ZodType<
+  PersonInfoSource,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  VantaBasedPersonInfoSource$inboundSchema,
+  ScimBasedPersonInfoSource$inboundSchema,
+  IntegrationBasedPersonInfoSource$inboundSchema,
+]);
+
+export function personInfoSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<PersonInfoSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PersonInfoSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonInfoSource' from JSON`,
+  );
+}