@gleanwork/api-client 0.3.0 → 0.4.0

package/src/models/components/dlpconfig.ts

@@ -0,0 +1,193 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AllowlistOptions,
+  AllowlistOptions$inboundSchema,
+  AllowlistOptions$Outbound,
+  AllowlistOptions$outboundSchema,
+} from "./allowlistoptions.js";
+import {
+  DlpPerson,
+  DlpPerson$inboundSchema,
+  DlpPerson$Outbound,
+  DlpPerson$outboundSchema,
+} from "./dlpperson.js";
+import {
+  ExternalSharingOptions,
+  ExternalSharingOptions$inboundSchema,
+  ExternalSharingOptions$Outbound,
+  ExternalSharingOptions$outboundSchema,
+} from "./externalsharingoptions.js";
+import {
+  InputOptions,
+  InputOptions$inboundSchema,
+  InputOptions$Outbound,
+  InputOptions$outboundSchema,
+} from "./inputoptions.js";
+import {
+  SensitiveContentOptions,
+  SensitiveContentOptions$inboundSchema,
+  SensitiveContentOptions$Outbound,
+  SensitiveContentOptions$outboundSchema,
+} from "./sensitivecontentoptions.js";
+import {
+  SensitiveInfoType,
+  SensitiveInfoType$inboundSchema,
+  SensitiveInfoType$Outbound,
+  SensitiveInfoType$outboundSchema,
+} from "./sensitiveinfotype.js";
+import {
+  SharingOptions,
+  SharingOptions$inboundSchema,
+  SharingOptions$Outbound,
+  SharingOptions$outboundSchema,
+} from "./sharingoptions.js";
+
+/**
+ * Detailed configuration of what documents and sensitive content will be scanned.
+ */
+export type DlpConfig = {
+  /**
+   * Synonymous with report/policy id.
+   */
+  version?: number | undefined;
+  /**
+   * DEPRECATED - use `sensitiveContentOptions` instead.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  sensitiveInfoTypes?: Array<SensitiveInfoType> | undefined;
+  /**
+   * Controls which data-sources and what time-range to include in scans.
+   */
+  inputOptions?: InputOptions | undefined;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  externalSharingOptions?: ExternalSharingOptions | undefined;
+  /**
+   * Controls how "shared" a document must be to get picked for scans.
+   */
+  broadSharingOptions?: SharingOptions | undefined;
+  /**
+   * Options for defining sensitive content within scanned documents.
+   */
+  sensitiveContentOptions?: SensitiveContentOptions | undefined;
+  reportName?: string | undefined;
+  /**
+   * Interval between scans.
+   */
+  frequency?: string | undefined;
+  /**
+   * Details about the person who created this report/policy.
+   */
+  createdBy?: DlpPerson | undefined;
+  /**
+   * Timestamp at which this configuration was created.
+   */
+  createdAt?: string | undefined;
+  /**
+   * redact quote in findings of the report
+   */
+  redactQuote?: boolean | undefined;
+  /**
+   * auto hide documents with findings in the report
+   */
+  autoHideDocs?: boolean | undefined;
+  /**
+   * Terms that are allow-listed during the scans. If any finding picked up by a rule exactly matches a term in the allow-list, it will not be counted as a violation.
+   */
+  allowlistOptions?: AllowlistOptions | undefined;
+};
+
+/** @internal */
+export const DlpConfig$inboundSchema: z.ZodType<
+  DlpConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  version: z.number().int().optional(),
+  sensitiveInfoTypes: z.array(SensitiveInfoType$inboundSchema).optional(),
+  inputOptions: InputOptions$inboundSchema.optional(),
+  externalSharingOptions: ExternalSharingOptions$inboundSchema.optional(),
+  broadSharingOptions: SharingOptions$inboundSchema.optional(),
+  sensitiveContentOptions: SensitiveContentOptions$inboundSchema.optional(),
+  reportName: z.string().optional(),
+  frequency: z.string().optional(),
+  createdBy: DlpPerson$inboundSchema.optional(),
+  createdAt: z.string().optional(),
+  redactQuote: z.boolean().optional(),
+  autoHideDocs: z.boolean().optional(),
+  allowlistOptions: AllowlistOptions$inboundSchema.optional(),
+});
+
+/** @internal */
+export type DlpConfig$Outbound = {
+  version?: number | undefined;
+  sensitiveInfoTypes?: Array<SensitiveInfoType$Outbound> | undefined;
+  inputOptions?: InputOptions$Outbound | undefined;
+  externalSharingOptions?: ExternalSharingOptions$Outbound | undefined;
+  broadSharingOptions?: SharingOptions$Outbound | undefined;
+  sensitiveContentOptions?: SensitiveContentOptions$Outbound | undefined;
+  reportName?: string | undefined;
+  frequency?: string | undefined;
+  createdBy?: DlpPerson$Outbound | undefined;
+  createdAt?: string | undefined;
+  redactQuote?: boolean | undefined;
+  autoHideDocs?: boolean | undefined;
+  allowlistOptions?: AllowlistOptions$Outbound | undefined;
+};
+
+/** @internal */
+export const DlpConfig$outboundSchema: z.ZodType<
+  DlpConfig$Outbound,
+  z.ZodTypeDef,
+  DlpConfig
+> = z.object({
+  version: z.number().int().optional(),
+  sensitiveInfoTypes: z.array(SensitiveInfoType$outboundSchema).optional(),
+  inputOptions: InputOptions$outboundSchema.optional(),
+  externalSharingOptions: ExternalSharingOptions$outboundSchema.optional(),
+  broadSharingOptions: SharingOptions$outboundSchema.optional(),
+  sensitiveContentOptions: SensitiveContentOptions$outboundSchema.optional(),
+  reportName: z.string().optional(),
+  frequency: z.string().optional(),
+  createdBy: DlpPerson$outboundSchema.optional(),
+  createdAt: z.string().optional(),
+  redactQuote: z.boolean().optional(),
+  autoHideDocs: z.boolean().optional(),
+  allowlistOptions: AllowlistOptions$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DlpConfig$ {
+  /** @deprecated use `DlpConfig$inboundSchema` instead. */
+  export const inboundSchema = DlpConfig$inboundSchema;
+  /** @deprecated use `DlpConfig$outboundSchema` instead. */
+  export const outboundSchema = DlpConfig$outboundSchema;
+  /** @deprecated use `DlpConfig$Outbound` instead. */
+  export type Outbound = DlpConfig$Outbound;
+}
+
+export function dlpConfigToJSON(dlpConfig: DlpConfig): string {
+  return JSON.stringify(DlpConfig$outboundSchema.parse(dlpConfig));
+}
+
+export function dlpConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<DlpConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DlpConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DlpConfig' from JSON`,
+  );
+}

package/src/models/components/dlpfrequency.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Interval between scans. DAILY is deprecated.
+ */
+export const DlpFrequency = {
+  Once: "ONCE",
+  Daily: "DAILY",
+  Weekly: "WEEKLY",
+  Continuous: "CONTINUOUS",
+  None: "NONE",
+} as const;
+/**
+ * Interval between scans. DAILY is deprecated.
+ */
+export type DlpFrequency = ClosedEnum<typeof DlpFrequency>;
+
+/** @internal */
+export const DlpFrequency$inboundSchema: z.ZodNativeEnum<typeof DlpFrequency> =
+  z.nativeEnum(DlpFrequency);
+
+/** @internal */
+export const DlpFrequency$outboundSchema: z.ZodNativeEnum<typeof DlpFrequency> =
+  DlpFrequency$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DlpFrequency$ {
+  /** @deprecated use `DlpFrequency$inboundSchema` instead. */
+  export const inboundSchema = DlpFrequency$inboundSchema;
+  /** @deprecated use `DlpFrequency$outboundSchema` instead. */
+  export const outboundSchema = DlpFrequency$outboundSchema;
+}

package/src/models/components/dlpperson.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  DlpPersonMetadata,
+  DlpPersonMetadata$inboundSchema,
+  DlpPersonMetadata$Outbound,
+  DlpPersonMetadata$outboundSchema,
+} from "./dlppersonmetadata.js";
+
+/**
+ * Details about the person who created this report/policy.
+ */
+export type DlpPerson = {
+  /**
+   * The display name.
+   */
+  name: string;
+  /**
+   * An opaque identifier that can be used to request metadata for a Person.
+   */
+  obfuscatedId: string;
+  metadata?: DlpPersonMetadata | undefined;
+};
+
+/** @internal */
+export const DlpPerson$inboundSchema: z.ZodType<
+  DlpPerson,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  obfuscatedId: z.string(),
+  metadata: DlpPersonMetadata$inboundSchema.optional(),
+});
+
+/** @internal */
+export type DlpPerson$Outbound = {
+  name: string;
+  obfuscatedId: string;
+  metadata?: DlpPersonMetadata$Outbound | undefined;
+};
+
+/** @internal */
+export const DlpPerson$outboundSchema: z.ZodType<
+  DlpPerson$Outbound,
+  z.ZodTypeDef,
+  DlpPerson
+> = z.object({
+  name: z.string(),
+  obfuscatedId: z.string(),
+  metadata: DlpPersonMetadata$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DlpPerson$ {
+  /** @deprecated use `DlpPerson$inboundSchema` instead. */
+  export const inboundSchema = DlpPerson$inboundSchema;
+  /** @deprecated use `DlpPerson$outboundSchema` instead. */
+  export const outboundSchema = DlpPerson$outboundSchema;
+  /** @deprecated use `DlpPerson$Outbound` instead. */
+  export type Outbound = DlpPerson$Outbound;
+}
+
+export function dlpPersonToJSON(dlpPerson: DlpPerson): string {
+  return JSON.stringify(DlpPerson$outboundSchema.parse(dlpPerson));
+}
+
+export function dlpPersonFromJSON(
+  jsonString: string,
+): SafeParseResult<DlpPerson, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DlpPerson$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DlpPerson' from JSON`,
+  );
+}

package/src/models/components/dlppersonmetadata.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type DlpPersonMetadata = {
+  /**
+   * The first name of the person
+   */
+  firstName?: string | undefined;
+  /**
+   * The user's primary email address
+   */
+  email?: string | undefined;
+};
+
+/** @internal */
+export const DlpPersonMetadata$inboundSchema: z.ZodType<
+  DlpPersonMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  firstName: z.string().optional(),
+  email: z.string().optional(),
+});
+
+/** @internal */
+export type DlpPersonMetadata$Outbound = {
+  firstName?: string | undefined;
+  email?: string | undefined;
+};
+
+/** @internal */
+export const DlpPersonMetadata$outboundSchema: z.ZodType<
+  DlpPersonMetadata$Outbound,
+  z.ZodTypeDef,
+  DlpPersonMetadata
+> = z.object({
+  firstName: z.string().optional(),
+  email: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DlpPersonMetadata$ {
+  /** @deprecated use `DlpPersonMetadata$inboundSchema` instead. */
+  export const inboundSchema = DlpPersonMetadata$inboundSchema;
+  /** @deprecated use `DlpPersonMetadata$outboundSchema` instead. */
+  export const outboundSchema = DlpPersonMetadata$outboundSchema;
+  /** @deprecated use `DlpPersonMetadata$Outbound` instead. */
+  export type Outbound = DlpPersonMetadata$Outbound;
+}
+
+export function dlpPersonMetadataToJSON(
+  dlpPersonMetadata: DlpPersonMetadata,
+): string {
+  return JSON.stringify(
+    DlpPersonMetadata$outboundSchema.parse(dlpPersonMetadata),
+  );
+}
+
+export function dlpPersonMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<DlpPersonMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DlpPersonMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DlpPersonMetadata' from JSON`,
+  );
+}

package/src/models/components/dlpreport.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  DlpConfig,
+  DlpConfig$inboundSchema,
+  DlpConfig$Outbound,
+  DlpConfig$outboundSchema,
+} from "./dlpconfig.js";
+import {
+  DlpFrequency,
+  DlpFrequency$inboundSchema,
+  DlpFrequency$outboundSchema,
+} from "./dlpfrequency.js";
+import {
+  DlpPerson,
+  DlpPerson$inboundSchema,
+  DlpPerson$Outbound,
+  DlpPerson$outboundSchema,
+} from "./dlpperson.js";
+import {
+  DlpReportStatus,
+  DlpReportStatus$inboundSchema,
+  DlpReportStatus$outboundSchema,
+} from "./dlpreportstatus.js";
+
+export const LastScanStatus = {
+  Pending: "PENDING",
+  Success: "SUCCESS",
+  Failure: "FAILURE",
+  Cancelled: "CANCELLED",
+  Cancelling: "CANCELLING",
+  Active: "ACTIVE",
+} as const;
+export type LastScanStatus = ClosedEnum<typeof LastScanStatus>;
+
+/**
+ * Full policy information that will be used for scans.
+ */
+export type DlpReport = {
+  id?: string | undefined;
+  name?: string | undefined;
+  /**
+   * Detailed configuration of what documents and sensitive content will be scanned.
+   */
+  config?: DlpConfig | undefined;
+  /**
+   * Interval between scans. DAILY is deprecated.
+   */
+  frequency?: DlpFrequency | undefined;
+  /**
+   * The status of the policy/report. Only ACTIVE status will be picked for scans.
+   */
+  status?: DlpReportStatus | undefined;
+  /**
+   * Details about the person who created this report/policy.
+   */
+  createdBy?: DlpPerson | undefined;
+  /**
+   * Timestamp at which the policy was created.
+   */
+  createdAt?: string | undefined;
+  /**
+   * Timestamp at which the policy was last updated.
+   */
+  lastUpdatedAt?: string | undefined;
+  /**
+   * Auto hide documents with findings in the policy.
+   */
+  autoHideDocs?: boolean | undefined;
+  lastScanStatus?: LastScanStatus | undefined;
+  /**
+   * The timestamp at which the report's last run/scan began.
+   */
+  lastScanStartTime?: string | undefined;
+  /**
+   * Details about the person who created this report/policy.
+   */
+  updatedBy?: DlpPerson | undefined;
+};
+
+/** @internal */
+export const LastScanStatus$inboundSchema: z.ZodNativeEnum<
+  typeof LastScanStatus
+> = z.nativeEnum(LastScanStatus);
+
+/** @internal */
+export const LastScanStatus$outboundSchema: z.ZodNativeEnum<
+  typeof LastScanStatus
+> = LastScanStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LastScanStatus$ {
+  /** @deprecated use `LastScanStatus$inboundSchema` instead. */
+  export const inboundSchema = LastScanStatus$inboundSchema;
+  /** @deprecated use `LastScanStatus$outboundSchema` instead. */
+  export const outboundSchema = LastScanStatus$outboundSchema;
+}
+
+/** @internal */
+export const DlpReport$inboundSchema: z.ZodType<
+  DlpReport,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  name: z.string().optional(),
+  config: DlpConfig$inboundSchema.optional(),
+  frequency: DlpFrequency$inboundSchema.optional(),
+  status: DlpReportStatus$inboundSchema.optional(),
+  createdBy: DlpPerson$inboundSchema.optional(),
+  createdAt: z.string().optional(),
+  lastUpdatedAt: z.string().optional(),
+  autoHideDocs: z.boolean().optional(),
+  lastScanStatus: LastScanStatus$inboundSchema.optional(),
+  lastScanStartTime: z.string().optional(),
+  updatedBy: DlpPerson$inboundSchema.optional(),
+});
+
+/** @internal */
+export type DlpReport$Outbound = {
+  id?: string | undefined;
+  name?: string | undefined;
+  config?: DlpConfig$Outbound | undefined;
+  frequency?: string | undefined;
+  status?: string | undefined;
+  createdBy?: DlpPerson$Outbound | undefined;
+  createdAt?: string | undefined;
+  lastUpdatedAt?: string | undefined;
+  autoHideDocs?: boolean | undefined;
+  lastScanStatus?: string | undefined;
+  lastScanStartTime?: string | undefined;
+  updatedBy?: DlpPerson$Outbound | undefined;
+};
+
+/** @internal */
+export const DlpReport$outboundSchema: z.ZodType<
+  DlpReport$Outbound,
+  z.ZodTypeDef,
+  DlpReport
+> = z.object({
+  id: z.string().optional(),
+  name: z.string().optional(),
+  config: DlpConfig$outboundSchema.optional(),
+  frequency: DlpFrequency$outboundSchema.optional(),
+  status: DlpReportStatus$outboundSchema.optional(),
+  createdBy: DlpPerson$outboundSchema.optional(),
+  createdAt: z.string().optional(),
+  lastUpdatedAt: z.string().optional(),
+  autoHideDocs: z.boolean().optional(),
+  lastScanStatus: LastScanStatus$outboundSchema.optional(),
+  lastScanStartTime: z.string().optional(),
+  updatedBy: DlpPerson$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DlpReport$ {
+  /** @deprecated use `DlpReport$inboundSchema` instead. */
+  export const inboundSchema = DlpReport$inboundSchema;
+  /** @deprecated use `DlpReport$outboundSchema` instead. */
+  export const outboundSchema = DlpReport$outboundSchema;
+  /** @deprecated use `DlpReport$Outbound` instead. */
+  export type Outbound = DlpReport$Outbound;
+}
+
+export function dlpReportToJSON(dlpReport: DlpReport): string {
+  return JSON.stringify(DlpReport$outboundSchema.parse(dlpReport));
+}
+
+export function dlpReportFromJSON(
+  jsonString: string,
+): SafeParseResult<DlpReport, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DlpReport$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DlpReport' from JSON`,
+  );
+}

package/src/models/components/dlpreportstatus.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The status of the policy/report. Only ACTIVE status will be picked for scans.
+ */
+export const DlpReportStatus = {
+  Active: "ACTIVE",
+  Inactive: "INACTIVE",
+  Cancelled: "CANCELLED",
+  None: "NONE",
+} as const;
+/**
+ * The status of the policy/report. Only ACTIVE status will be picked for scans.
+ */
+export type DlpReportStatus = ClosedEnum<typeof DlpReportStatus>;
+
+/** @internal */
+export const DlpReportStatus$inboundSchema: z.ZodNativeEnum<
+  typeof DlpReportStatus
+> = z.nativeEnum(DlpReportStatus);
+
+/** @internal */
+export const DlpReportStatus$outboundSchema: z.ZodNativeEnum<
+  typeof DlpReportStatus
+> = DlpReportStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DlpReportStatus$ {
+  /** @deprecated use `DlpReportStatus$inboundSchema` instead. */
+  export const inboundSchema = DlpReportStatus$inboundSchema;
+  /** @deprecated use `DlpReportStatus$outboundSchema` instead. */
+  export const outboundSchema = DlpReportStatus$outboundSchema;
+}

package/src/models/components/dlpsimpleresult.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const DlpSimpleResult = {
+  Success: "SUCCESS",
+  Failure: "FAILURE",
+} as const;
+export type DlpSimpleResult = ClosedEnum<typeof DlpSimpleResult>;
+
+/** @internal */
+export const DlpSimpleResult$inboundSchema: z.ZodNativeEnum<
+  typeof DlpSimpleResult
+> = z.nativeEnum(DlpSimpleResult);
+
+/** @internal */
+export const DlpSimpleResult$outboundSchema: z.ZodNativeEnum<
+  typeof DlpSimpleResult
+> = DlpSimpleResult$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DlpSimpleResult$ {
+  /** @deprecated use `DlpSimpleResult$inboundSchema` instead. */
+  export const inboundSchema = DlpSimpleResult$inboundSchema;
+  /** @deprecated use `DlpSimpleResult$outboundSchema` instead. */
+  export const outboundSchema = DlpSimpleResult$outboundSchema;
+}