vanta-auditor-api-sdk 0.6.3 → 0.6.4

package/src/funcs/auditsListVulnerabilityRemediationsInAuditScope.ts

@@ -0,0 +1,186 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { VantaCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { VantaError } from "../models/errors/vantaerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List vulnerability remediations that are in scope for this audit
+ *
+ * @remarks
+ * List all vulnerability remediations based on selected filters that are in scope for this audit.
+ */
+export function auditsListVulnerabilityRemediationsInAuditScope(
+  client: VantaCore,
+  request: operations.ListVulnerabilityRemediationsInAuditScopeRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.PaginatedResponseVulnerabilityRemediation,
+    | VantaError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: VantaCore,
+  request: operations.ListVulnerabilityRemediationsInAuditScopeRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.PaginatedResponseVulnerabilityRemediation,
+      | VantaError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListVulnerabilityRemediationsInAuditScopeRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    auditId: encodeSimple("auditId", payload.auditId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/audits/{auditId}/vulnerability-remediations")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "integrationId": payload.integrationId,
+    "isRemediatedOnTime": payload.isRemediatedOnTime,
+    "pageCursor": payload.pageCursor,
+    "pageSize": payload.pageSize,
+    "remediatedAfterDate": payload.remediatedAfterDate,
+    "remediatedBeforeDate": payload.remediatedBeforeDate,
+    "severity": payload.severity,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.bearerAuth);
+  const securityInput = secConfig == null ? {} : { bearerAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "ListVulnerabilityRemediationsInAuditScope",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.bearerAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    components.PaginatedResponseVulnerabilityRemediation,
+    | VantaError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      components.PaginatedResponseVulnerabilityRemediation$inboundSchema,
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -65,8 +65,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.6.3",
-  genVersion: "2.884.13",
+  sdkVersion: "0.6.4",
+  genVersion: "2.885.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.6.3 2.884.13 1.0.0 vanta-auditor-api-sdk",
+    "speakeasy-sdk/typescript 0.6.4 2.885.0 1.0.0 vanta-auditor-api-sdk",
 } as const;

package/src/models/components/acceptpoliciestasksummary.ts

@@ -0,0 +1,155 @@
+/*
+ * 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 { TaskStatus, TaskStatus$inboundSchema } from "./taskstatus.js";
+import {
+  TaskTypeACCEPTPOLICIES,
+  TaskTypeACCEPTPOLICIES$inboundSchema,
+} from "./tasktypeacceptpolicies.js";
+
+/**
+ * If the task is disabled, the reason and date when it was disabled.
+ */
+export type AcceptPoliciesTaskSummaryDisabled = {
+  date: Date;
+  reason: string | null;
+};
+
+export type UnacceptedPolicies = {
+  name: string;
+};
+
+export type AcceptedPolicies = {
+  name: string;
+};
+
+/**
+ * Policy acceptance details for a person.
+ */
+export type AcceptPoliciesTaskSummary = {
+  taskType: TaskTypeACCEPTPOLICIES;
+  /**
+   * The status of a task.
+   *
+   * @remarks
+   * - COMPLETE: The task has been completed.
+   * - DUE_SOON: The task is due soon.
+   * - OVERDUE: The task is overdue.
+   * - NONE: The task is not assigned.
+   */
+  status: TaskStatus;
+  /**
+   * The due date of the task.
+   */
+  dueDate: Date | null;
+  /**
+   * The date the task was completed.
+   */
+  completionDate: Date | null;
+  /**
+   * If the task is disabled, the reason and date when it was disabled.
+   */
+  disabled: AcceptPoliciesTaskSummaryDisabled | null;
+  /**
+   * Unaccepted policies that are relevant to the person.
+   */
+  unacceptedPolicies: Array<UnacceptedPolicies>;
+  /**
+   * Accepted policies that are relevant to the person.
+   */
+  acceptedPolicies: Array<AcceptedPolicies>;
+};
+
+/** @internal */
+export const AcceptPoliciesTaskSummaryDisabled$inboundSchema: z.ZodType<
+  AcceptPoliciesTaskSummaryDisabled,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  reason: z.nullable(z.string()),
+});
+
+export function acceptPoliciesTaskSummaryDisabledFromJSON(
+  jsonString: string,
+): SafeParseResult<AcceptPoliciesTaskSummaryDisabled, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AcceptPoliciesTaskSummaryDisabled$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AcceptPoliciesTaskSummaryDisabled' from JSON`,
+  );
+}
+
+/** @internal */
+export const UnacceptedPolicies$inboundSchema: z.ZodType<
+  UnacceptedPolicies,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+});
+
+export function unacceptedPoliciesFromJSON(
+  jsonString: string,
+): SafeParseResult<UnacceptedPolicies, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UnacceptedPolicies$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UnacceptedPolicies' from JSON`,
+  );
+}
+
+/** @internal */
+export const AcceptedPolicies$inboundSchema: z.ZodType<
+  AcceptedPolicies,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+});
+
+export function acceptedPoliciesFromJSON(
+  jsonString: string,
+): SafeParseResult<AcceptedPolicies, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AcceptedPolicies$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AcceptedPolicies' from JSON`,
+  );
+}
+
+/** @internal */
+export const AcceptPoliciesTaskSummary$inboundSchema: z.ZodType<
+  AcceptPoliciesTaskSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  taskType: TaskTypeACCEPTPOLICIES$inboundSchema,
+  status: TaskStatus$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)),
+  ),
+  disabled: z.nullable(
+    z.lazy(() => AcceptPoliciesTaskSummaryDisabled$inboundSchema),
+  ),
+  unacceptedPolicies: z.array(z.lazy(() => UnacceptedPolicies$inboundSchema)),
+  acceptedPolicies: z.array(z.lazy(() => AcceptedPolicies$inboundSchema)),
+});
+
+export function acceptPoliciesTaskSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<AcceptPoliciesTaskSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AcceptPoliciesTaskSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AcceptPoliciesTaskSummary' from JSON`,
+  );
+}

package/src/models/components/auditorapivulnerability.ts

@@ -0,0 +1,200 @@
+/*
+ * 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 {
+  ExternalFindingSeverityType,
+  ExternalFindingSeverityType$inboundSchema,
+} from "./externalfindingseveritytype.js";
+import {
+  VulnerabilityType,
+  VulnerabilityType$inboundSchema,
+} from "./vulnerabilitytype.js";
+
+/**
+ * Metadata for the deactivation of the vulnerability.
+ */
+export type DeactivateMetadata = {
+  /**
+   * Whether the vulnerability is deactivated indefinitely.
+   */
+  isVulnDeactivatedIndefinitely: boolean;
+  /**
+   * Date when the vulnerability will be reactivated.
+   */
+  deactivatedUntilDate: Date | null;
+  /**
+   * Reason for deactivating the vulnerability.
+   */
+  deactivationReason: string;
+  /**
+   * Date when the vulnerability was deactivated.
+   */
+  deactivatedOnDate: Date;
+  /**
+   * Identifier of the user who deactivated the vulnerability.
+   */
+  deactivatedBy: string;
+};
+
+export type AuditorApiVulnerability = {
+  /**
+   * Unique identifier for the vulnerability.
+   */
+  id: string;
+  /**
+   * Display name of the vulnerability.
+   */
+  name: string;
+  /**
+   * Description of the vulnerability.
+   */
+  description: string;
+  /**
+   * Integration that the vulnerability is scanned by.
+   */
+  integrationId: string;
+  /**
+   * Identifier for the package that the vulnerability is found on.
+   *
+   * @remarks
+   * Only relevant to vulnerabilities of type COMMON or GROUPED.
+   */
+  packageIdentifier: string | null;
+  vulnerabilityType: VulnerabilityType;
+  /**
+   * Unique identifier for the underlying resource that the vulnerability is found on.
+   */
+  targetId: string;
+  /**
+   * Date when the vulnerability was first detected by Vanta.
+   */
+  firstDetectedDate: Date;
+  /**
+   * Date when the vulnerability was first detected by the source.
+   */
+  sourceDetectedDate: Date | null;
+  /**
+   * Date when the vulnerability was last detected.
+   */
+  lastDetectedDate: Date | null;
+  severity: ExternalFindingSeverityType;
+  /**
+   * CVSS severity score of the vulnerability.
+   */
+  cvssSeverityScore: number | null;
+  /**
+   * Scanner score of the vulnerability.
+   */
+  scannerScore: number | null;
+  /**
+   * Whether the vulnerability is fixable.
+   */
+  isFixable: boolean;
+  /**
+   * Date when the vulnerability should be remediated by.
+   */
+  remediateByDate: Date | null;
+  /**
+   * Related vulnerabilities.
+   *
+   * @remarks
+   * Only relevant to vulnerabilities of type GROUPED.
+   */
+  relatedVulns: Array<string>;
+  /**
+   * Related URLs.
+   */
+  relatedUrls: Array<string>;
+  /**
+   * External URL for the vulnerability.
+   */
+  externalURL: string;
+  /**
+   * Scanning tool that detected the vulnerability
+   */
+  scanSource?: string | undefined;
+  /**
+   * Metadata for the deactivation of the vulnerability.
+   */
+  deactivateMetadata: DeactivateMetadata | null;
+};
+
+/** @internal */
+export const DeactivateMetadata$inboundSchema: z.ZodType<
+  DeactivateMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  isVulnDeactivatedIndefinitely: z.boolean(),
+  deactivatedUntilDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  deactivationReason: z.string(),
+  deactivatedOnDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  deactivatedBy: z.string(),
+});
+
+export function deactivateMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<DeactivateMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeactivateMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeactivateMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const AuditorApiVulnerability$inboundSchema: z.ZodType<
+  AuditorApiVulnerability,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+  description: z.string(),
+  integrationId: z.string(),
+  packageIdentifier: z.nullable(z.string()),
+  vulnerabilityType: VulnerabilityType$inboundSchema,
+  targetId: z.string(),
+  firstDetectedDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  sourceDetectedDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  lastDetectedDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  severity: ExternalFindingSeverityType$inboundSchema,
+  cvssSeverityScore: z.nullable(z.number()),
+  scannerScore: z.nullable(z.number()),
+  isFixable: z.boolean(),
+  remediateByDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  relatedVulns: z.array(z.string()),
+  relatedUrls: z.array(z.string()),
+  externalURL: z.string(),
+  scanSource: z.string().optional(),
+  deactivateMetadata: z.nullable(
+    z.lazy(() => DeactivateMetadata$inboundSchema),
+  ),
+});
+
+export function auditorApiVulnerabilityFromJSON(
+  jsonString: string,
+): SafeParseResult<AuditorApiVulnerability, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuditorApiVulnerability$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuditorApiVulnerability' from JSON`,
+  );
+}

package/src/models/components/completebackgroundcheckstasksummary.ts

@@ -0,0 +1,107 @@
+/*
+ * 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 { TaskStatus, TaskStatus$inboundSchema } from "./taskstatus.js";
+import {
+  TaskTypeCOMPLETEBACKGROUNDCHECKS,
+  TaskTypeCOMPLETEBACKGROUNDCHECKS$inboundSchema,
+} from "./tasktypecompletebackgroundchecks.js";
+
+/**
+ * If the task is disabled, the reason and date when it was disabled.
+ */
+export type CompleteBackgroundChecksTaskSummaryDisabled = {
+  date: Date;
+  reason: string | null;
+};
+
+/**
+ * Task summary for completing background checks.
+ */
+export type CompleteBackgroundChecksTaskSummary = {
+  taskType: TaskTypeCOMPLETEBACKGROUNDCHECKS;
+  /**
+   * The status of a task.
+   *
+   * @remarks
+   * - COMPLETE: The task has been completed.
+   * - DUE_SOON: The task is due soon.
+   * - OVERDUE: The task is overdue.
+   * - NONE: The task is not assigned.
+   */
+  status: TaskStatus;
+  /**
+   * The due date of the task.
+   */
+  dueDate: Date | null;
+  /**
+   * The date the task was completed.
+   */
+  completionDate: Date | null;
+  /**
+   * If the task is disabled, the reason and date when it was disabled.
+   */
+  disabled: CompleteBackgroundChecksTaskSummaryDisabled | null;
+};
+
+/** @internal */
+export const CompleteBackgroundChecksTaskSummaryDisabled$inboundSchema:
+  z.ZodType<
+    CompleteBackgroundChecksTaskSummaryDisabled,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    reason: z.nullable(z.string()),
+  });
+
+export function completeBackgroundChecksTaskSummaryDisabledFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CompleteBackgroundChecksTaskSummaryDisabled,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CompleteBackgroundChecksTaskSummaryDisabled$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CompleteBackgroundChecksTaskSummaryDisabled' from JSON`,
+  );
+}
+
+/** @internal */
+export const CompleteBackgroundChecksTaskSummary$inboundSchema: z.ZodType<
+  CompleteBackgroundChecksTaskSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  taskType: TaskTypeCOMPLETEBACKGROUNDCHECKS$inboundSchema,
+  status: TaskStatus$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)),
+  ),
+  disabled: z.nullable(
+    z.lazy(() => CompleteBackgroundChecksTaskSummaryDisabled$inboundSchema),
+  ),
+});
+
+export function completeBackgroundChecksTaskSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<CompleteBackgroundChecksTaskSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CompleteBackgroundChecksTaskSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompleteBackgroundChecksTaskSummary' from JSON`,
+  );
+}