vanta-auditor-api-sdk 0.7.1 → 0.7.3

package/src/funcs/auditsGetInformationRequestTestSnapshotEvidenceDetail.ts

@@ -32,17 +32,25 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Retrieves the rich detail for a single VANTA_TEST_SNAPSHOT evidence row
  * attached to an information request. The response includes test-level
- * metadata (description, integrations, SLA) and the raw test data captured
- * at snapshot time, presented as a uniform array of rows regardless of
- * whether the snapshot is structured or unstructured.
+ * metadata (description, integrations, SLA), the raw test data captured
+ * at snapshot time, and the resources that were excluded from the test
+ * (out-of-scope resources).
  *
- * For structured snapshots, the array contains one row per resource the
- * test ran against; each row carries `resourceId`, `resourceType`, and the
- * raw JSON for that resource.
+ * For structured snapshots, the `rawTestData` array contains one row per
+ * resource the test ran against; each row carries `resourceId`,
+ * `resourceType`, and the raw JSON for that resource.
  *
- * For unstructured snapshots, the array contains a single row with
- * `resourceId` and `resourceType` set to `null` and `rawJson` containing
- * the entire test-run JSON blob.
+ * For unstructured snapshots, the `rawTestData` array contains a single
+ * row with `resourceId` and `resourceType` set to `null` and `rawJson`
+ * containing the entire test-run JSON blob.
+ *
+ * The `outOfScopeResources` field lists resources excluded at the test
+ * level (customer-disabled) and the framework level (segment
+ * configuration). Empty exclusion groups are filtered out.
+ *
+ * The `apiRequests` array contains the HTTP requests captured during API
+ * introspection tests. Empty when the test does not perform API
+ * introspection.
  */
 export function auditsGetInformationRequestTestSnapshotEvidenceDetail(
   client: VantaCore,

package/src/funcs/auditsListAuditIssues.ts

@@ -39,6 +39,8 @@ import { Result } from "../types/fp.js";
  * Supports filtering by:
  * - `search`: full text search across issue title and description
  * - `snapshotId`: filtering to a specific snapshot or snapshots, which represent point-in-time captures of issues. Use the GET /audits/{auditId}/issues/snapshots endpoint to retrieve snapshot IDs and metadata.
+ * - `createdAfterDate` / `createdBeforeDate`: filter to issues created within a date range (inclusive)
+ * - `detectedAfterDate` / `detectedBeforeDate`: filter to issues detected within a date range (inclusive)
  *
  * Results are sorted by issue creation date in descending order (newest first) by default.
  * Use `orderBy` and `orderDirection` to customize sorting.
@@ -113,6 +115,10 @@ async function $do(
   const path = pathToFunc("/audits/{auditId}/issues/items")(pathParams);
 
   const query = encodeFormQuery({
+    "createdAfterDate": payload.createdAfterDate,
+    "createdBeforeDate": payload.createdBeforeDate,
+    "detectedAfterDate": payload.detectedAfterDate,
+    "detectedBeforeDate": payload.detectedBeforeDate,
     "orderBy": payload.orderBy,
     "orderDirection": payload.orderDirection,
     "pageCursor": payload.pageCursor,

package/src/funcs/auditsListCodeChanges.ts

@@ -38,7 +38,7 @@ import { Result } from "../types/fp.js";
  * Supports filtering by:
  * - `search`: Searches code change titles and repository names (case-insensitive)
  * - `sourcesMatchesAny`: Filters by version control source (accepted values: github, gitlab, bitbucket, azuredevops)
- * - `startDate` / `endDate`: Filters by the closed date range
+ * - `closedAfterDate` / `closedBeforeDate`: Filters by the closed date range
  *
  * Uses cursor-based pagination. To paginate:
  * 1. Make initial request with desired `pageSize`
@@ -112,12 +112,12 @@ async function $do(
   const path = pathToFunc("/audits/{auditId}/assets/code-changes")(pathParams);
 
   const query = encodeFormQuery({
-    "endDate": payload.endDate,
+    "closedAfterDate": payload.closedAfterDate,
+    "closedBeforeDate": payload.closedBeforeDate,
     "pageCursor": payload.pageCursor,
     "pageSize": payload.pageSize,
     "search": payload.search,
     "sourcesMatchesAny": payload.sourcesMatchesAny,
-    "startDate": payload.startDate,
   });
 
   const headers = new Headers(compactMap({

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.7.1",
-  genVersion: "2.892.5",
+  sdkVersion: "0.7.3",
+  genVersion: "2.893.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.7.1 2.892.5 1.0.0 vanta-auditor-api-sdk",
+    "speakeasy-sdk/typescript 0.7.3 2.893.0 1.0.0 vanta-auditor-api-sdk",
 } as const;

package/src/models/components/index.ts

@@ -142,9 +142,14 @@ export * from "./vantapolicyevidence.js";
 export * from "./vantatestevidence.js";
 export * from "./vantatestfiletype.js";
 export * from "./vantatestrunstatus.js";
+export * from "./vantatestsnapshotapirequest.js";
 export * from "./vantatestsnapshotevidence.js";
 export * from "./vantatestsnapshotevidencedetail.js";
+export * from "./vantatestsnapshotexcludeditem.js";
+export * from "./vantatestsnapshotexcludeditemgroup.js";
+export * from "./vantatestsnapshotframeworkexclusion.js";
 export * from "./vantatestsnapshotintegration.js";
+export * from "./vantatestsnapshotoutofscoperesources.js";
 export * from "./vantatestsnapshotrawtestdatarow.js";
 export * from "./vendor.js";
 export * from "./vendordecisionstatus.js";

package/src/models/components/issuesnapshotitemorderby.ts

@@ -11,6 +11,7 @@ import { ClosedEnum } from "../../types/enums.js";
 export const IssueSnapshotItemOrderBy = {
   CreatedAt: "createdAt",
   LastModifiedAt: "lastModifiedAt",
+  DetectedAt: "detectedAt",
 } as const;
 /**
  * Allowed values for the `orderBy` query parameter on issue snapshot item endpoints.

package/src/models/components/vantatestsnapshotapirequest.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 single API request captured during an API introspection test run.
+ */
+export type VantaTestSnapshotApiRequest = {
+  id: string;
+  resourceType: string;
+  resourceTypeDisplayName: string;
+  requestMethod: string;
+  url: string;
+  responseCode: number;
+  timestamp: Date;
+  dataTooLarge: boolean;
+};
+
+/** @internal */
+export const VantaTestSnapshotApiRequest$inboundSchema: z.ZodType<
+  VantaTestSnapshotApiRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  resourceType: z.string(),
+  resourceTypeDisplayName: z.string(),
+  requestMethod: z.string(),
+  url: z.string(),
+  responseCode: z.number(),
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  dataTooLarge: z.boolean(),
+});
+
+export function vantaTestSnapshotApiRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaTestSnapshotApiRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaTestSnapshotApiRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaTestSnapshotApiRequest' from JSON`,
+  );
+}

package/src/models/components/vantatestsnapshotevidencedetail.ts

@@ -6,10 +6,18 @@ 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 {
+  VantaTestSnapshotApiRequest,
+  VantaTestSnapshotApiRequest$inboundSchema,
+} from "./vantatestsnapshotapirequest.js";
 import {
   VantaTestSnapshotIntegration,
   VantaTestSnapshotIntegration$inboundSchema,
 } from "./vantatestsnapshotintegration.js";
+import {
+  VantaTestSnapshotOutOfScopeResources,
+  VantaTestSnapshotOutOfScopeResources$inboundSchema,
+} from "./vantatestsnapshotoutofscoperesources.js";
 import {
   VantaTestSnapshotRawTestDataRow,
   VantaTestSnapshotRawTestDataRow$inboundSchema,
@@ -67,6 +75,23 @@ export type VantaTestSnapshotEvidenceDetail = {
    * Raw test data captured at snapshot time.
    */
   rawTestData: Array<VantaTestSnapshotRawTestDataRow>;
+  /**
+   * Resources excluded from the test at snapshot time, grouped by exclusion
+   *
+   * @remarks
+   * reason.  `testLevel` contains resources the customer disabled for the
+   * test; `frameworkLevel` contains resources scoped out by the framework's
+   * segment configuration.
+   */
+  outOfScopeResources?: VantaTestSnapshotOutOfScopeResources | undefined;
+  /**
+   * API requests captured during the test run. Absent when the snapshot
+   *
+   * @remarks
+   * data could not be loaded. Empty array when the test does not perform
+   * API introspection.
+   */
+  apiRequests?: Array<VantaTestSnapshotApiRequest> | undefined;
 };
 
 /** @internal */
@@ -122,6 +147,9 @@ export const VantaTestSnapshotEvidenceDetail$inboundSchema: z.ZodType<
   integrations: z.array(VantaTestSnapshotIntegration$inboundSchema),
   slaRemediation: z.nullable(z.lazy(() => SlaRemediation$inboundSchema)),
   rawTestData: z.array(VantaTestSnapshotRawTestDataRow$inboundSchema),
+  outOfScopeResources: VantaTestSnapshotOutOfScopeResources$inboundSchema
+    .optional(),
+  apiRequests: z.array(VantaTestSnapshotApiRequest$inboundSchema).optional(),
 });
 
 export function vantaTestSnapshotEvidenceDetailFromJSON(

package/src/models/components/vantatestsnapshotexcludeditem.ts

@@ -0,0 +1,33 @@
+/*
+ * 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";
+
+export type VantaTestSnapshotExcludedItem = {
+  id: string;
+  displayName: string | null;
+};
+
+/** @internal */
+export const VantaTestSnapshotExcludedItem$inboundSchema: z.ZodType<
+  VantaTestSnapshotExcludedItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  displayName: z.nullable(z.string()),
+});
+
+export function vantaTestSnapshotExcludedItemFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaTestSnapshotExcludedItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaTestSnapshotExcludedItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaTestSnapshotExcludedItem' from JSON`,
+  );
+}

package/src/models/components/vantatestsnapshotexcludeditemgroup.ts

@@ -0,0 +1,38 @@
+/*
+ * 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 {
+  VantaTestSnapshotExcludedItem,
+  VantaTestSnapshotExcludedItem$inboundSchema,
+} from "./vantatestsnapshotexcludeditem.js";
+
+export type VantaTestSnapshotExcludedItemGroup = {
+  reason: string;
+  entities: Array<VantaTestSnapshotExcludedItem>;
+};
+
+/** @internal */
+export const VantaTestSnapshotExcludedItemGroup$inboundSchema: z.ZodType<
+  VantaTestSnapshotExcludedItemGroup,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  reason: z.string(),
+  entities: z.array(VantaTestSnapshotExcludedItem$inboundSchema),
+});
+
+export function vantaTestSnapshotExcludedItemGroupFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaTestSnapshotExcludedItemGroup, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      VantaTestSnapshotExcludedItemGroup$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaTestSnapshotExcludedItemGroup' from JSON`,
+  );
+}

package/src/models/components/vantatestsnapshotframeworkexclusion.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 {
+  VantaTestSnapshotExcludedItemGroup,
+  VantaTestSnapshotExcludedItemGroup$inboundSchema,
+} from "./vantatestsnapshotexcludeditemgroup.js";
+
+export type VantaTestSnapshotFrameworkExclusion = {
+  frameworkId: string;
+  frameworkName: string;
+  groupedByReason: Array<VantaTestSnapshotExcludedItemGroup>;
+};
+
+/** @internal */
+export const VantaTestSnapshotFrameworkExclusion$inboundSchema: z.ZodType<
+  VantaTestSnapshotFrameworkExclusion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  frameworkId: z.string(),
+  frameworkName: z.string(),
+  groupedByReason: z.array(VantaTestSnapshotExcludedItemGroup$inboundSchema),
+});
+
+export function vantaTestSnapshotFrameworkExclusionFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaTestSnapshotFrameworkExclusion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      VantaTestSnapshotFrameworkExclusion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaTestSnapshotFrameworkExclusion' from JSON`,
+  );
+}

package/src/models/components/vantatestsnapshotoutofscoperesources.ts

@@ -0,0 +1,50 @@
+/*
+ * 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 {
+  VantaTestSnapshotExcludedItemGroup,
+  VantaTestSnapshotExcludedItemGroup$inboundSchema,
+} from "./vantatestsnapshotexcludeditemgroup.js";
+import {
+  VantaTestSnapshotFrameworkExclusion,
+  VantaTestSnapshotFrameworkExclusion$inboundSchema,
+} from "./vantatestsnapshotframeworkexclusion.js";
+
+/**
+ * Resources excluded from the test at snapshot time, grouped by exclusion
+ *
+ * @remarks
+ * reason.  `testLevel` contains resources the customer disabled for the
+ * test; `frameworkLevel` contains resources scoped out by the framework's
+ * segment configuration.
+ */
+export type VantaTestSnapshotOutOfScopeResources = {
+  testLevel: Array<VantaTestSnapshotExcludedItemGroup>;
+  frameworkLevel: Array<VantaTestSnapshotFrameworkExclusion>;
+};
+
+/** @internal */
+export const VantaTestSnapshotOutOfScopeResources$inboundSchema: z.ZodType<
+  VantaTestSnapshotOutOfScopeResources,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  testLevel: z.array(VantaTestSnapshotExcludedItemGroup$inboundSchema),
+  frameworkLevel: z.array(VantaTestSnapshotFrameworkExclusion$inboundSchema),
+});
+
+export function vantaTestSnapshotOutOfScopeResourcesFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaTestSnapshotOutOfScopeResources, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      VantaTestSnapshotOutOfScopeResources$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaTestSnapshotOutOfScopeResources' from JSON`,
+  );
+}

package/src/models/operations/listauditissues.ts

@@ -27,7 +27,23 @@ export type ListAuditIssuesRequest = {
    */
   snapshotIdMatchesAny?: Array<string> | undefined;
   /**
-   * Field to sort results by. Allowed: "createdAt", "lastModifiedAt". Default: "createdAt"
+   * Filter to issues created on or after this date (ISO 8601)
+   */
+  createdAfterDate?: Date | undefined;
+  /**
+   * Filter to issues created on or before this date (ISO 8601)
+   */
+  createdBeforeDate?: Date | undefined;
+  /**
+   * Filter to issues detected on or after this date (ISO 8601)
+   */
+  detectedAfterDate?: Date | undefined;
+  /**
+   * Filter to issues detected on or before this date (ISO 8601)
+   */
+  detectedBeforeDate?: Date | undefined;
+  /**
+   * Field to sort results by. Allowed: "createdAt", "lastModifiedAt", "detectedAt". Default: "createdAt"
    */
   orderBy?: components.IssueSnapshotItemOrderBy | undefined;
   /**
@@ -43,6 +59,10 @@ export type ListAuditIssuesRequest$Outbound = {
   pageCursor?: string | undefined;
   search?: string | undefined;
   snapshotIdMatchesAny?: Array<string> | undefined;
+  createdAfterDate?: string | undefined;
+  createdBeforeDate?: string | undefined;
+  detectedAfterDate?: string | undefined;
+  detectedBeforeDate?: string | undefined;
   orderBy?: string | undefined;
   orderDirection?: string | undefined;
 };
@@ -58,6 +78,10 @@ export const ListAuditIssuesRequest$outboundSchema: z.ZodType<
   pageCursor: z.string().optional(),
   search: z.string().optional(),
   snapshotIdMatchesAny: z.array(z.string()).optional(),
+  createdAfterDate: z.date().transform(v => v.toISOString()).optional(),
+  createdBeforeDate: z.date().transform(v => v.toISOString()).optional(),
+  detectedAfterDate: z.date().transform(v => v.toISOString()).optional(),
+  detectedBeforeDate: z.date().transform(v => v.toISOString()).optional(),
   orderBy: components.IssueSnapshotItemOrderBy$outboundSchema.optional(),
   orderDirection: components.OrderDirection$outboundSchema.optional(),
 });

package/src/models/operations/listcodechanges.ts

@@ -29,11 +29,11 @@ export type ListCodeChangesRequest = {
   /**
    * Filter code changes closed on or after this date (ISO 8601)
    */
-  startDate?: Date | undefined;
+  closedAfterDate?: Date | undefined;
   /**
    * Filter code changes closed on or before this date (ISO 8601)
    */
-  endDate?: Date | undefined;
+  closedBeforeDate?: Date | undefined;
 };
 
 /** @internal */
@@ -43,8 +43,8 @@ export type ListCodeChangesRequest$Outbound = {
   pageCursor?: string | undefined;
   search?: string | undefined;
   sourcesMatchesAny?: Array<string> | undefined;
-  startDate?: string | undefined;
-  endDate?: string | undefined;
+  closedAfterDate?: string | undefined;
+  closedBeforeDate?: string | undefined;
 };
 
 /** @internal */
@@ -59,8 +59,8 @@ export const ListCodeChangesRequest$outboundSchema: z.ZodType<
   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(),
+  closedAfterDate: z.date().transform(v => v.toISOString()).optional(),
+  closedBeforeDate: z.date().transform(v => v.toISOString()).optional(),
 });
 
 export function listCodeChangesRequestToJSON(

package/src/sdk/audits.ts

@@ -105,7 +105,7 @@ export class Audits extends ClientSDK {
    * Supports filtering by:
    * - `search`: Searches code change titles and repository names (case-insensitive)
    * - `sourcesMatchesAny`: Filters by version control source (accepted values: github, gitlab, bitbucket, azuredevops)
-   * - `startDate` / `endDate`: Filters by the closed date range
+   * - `closedAfterDate` / `closedBeforeDate`: Filters by the closed date range
    *
    * Uses cursor-based pagination. To paginate:
    * 1. Make initial request with desired `pageSize`
@@ -661,17 +661,25 @@ export class Audits extends ClientSDK {
    * @remarks
    * Retrieves the rich detail for a single VANTA_TEST_SNAPSHOT evidence row
    * attached to an information request. The response includes test-level
-   * metadata (description, integrations, SLA) and the raw test data captured
-   * at snapshot time, presented as a uniform array of rows regardless of
-   * whether the snapshot is structured or unstructured.
+   * metadata (description, integrations, SLA), the raw test data captured
+   * at snapshot time, and the resources that were excluded from the test
+   * (out-of-scope resources).
    *
-   * For structured snapshots, the array contains one row per resource the
-   * test ran against; each row carries `resourceId`, `resourceType`, and the
-   * raw JSON for that resource.
+   * For structured snapshots, the `rawTestData` array contains one row per
+   * resource the test ran against; each row carries `resourceId`,
+   * `resourceType`, and the raw JSON for that resource.
    *
-   * For unstructured snapshots, the array contains a single row with
-   * `resourceId` and `resourceType` set to `null` and `rawJson` containing
-   * the entire test-run JSON blob.
+   * For unstructured snapshots, the `rawTestData` array contains a single
+   * row with `resourceId` and `resourceType` set to `null` and `rawJson`
+   * containing the entire test-run JSON blob.
+   *
+   * The `outOfScopeResources` field lists resources excluded at the test
+   * level (customer-disabled) and the framework level (segment
+   * configuration). Empty exclusion groups are filtered out.
+   *
+   * The `apiRequests` array contains the HTTP requests captured during API
+   * introspection tests. Empty when the test does not perform API
+   * introspection.
    */
   async getInformationRequestTestSnapshotEvidenceDetail(
     request: operations.GetInformationRequestTestSnapshotEvidenceDetailRequest,
@@ -729,6 +737,8 @@ export class Audits extends ClientSDK {
    * Supports filtering by:
    * - `search`: full text search across issue title and description
    * - `snapshotId`: filtering to a specific snapshot or snapshots, which represent point-in-time captures of issues. Use the GET /audits/{auditId}/issues/snapshots endpoint to retrieve snapshot IDs and metadata.
+   * - `createdAfterDate` / `createdBeforeDate`: filter to issues created within a date range (inclusive)
+   * - `detectedAfterDate` / `detectedBeforeDate`: filter to issues detected within a date range (inclusive)
    *
    * Results are sorted by issue creation date in descending order (newest first) by default.
    * Use `orderBy` and `orderDirection` to customize sorting.