@gleanwork/api-client 0.3.0 → 0.4.0

package/src/models/components/reportstatusresponse.ts

@@ -0,0 +1,107 @@
+/*
+ * 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";
+
+export const ReportStatusResponseStatus = {
+  Pending: "PENDING",
+  Success: "SUCCESS",
+  Failure: "FAILURE",
+  Cancelled: "CANCELLED",
+  Cancelling: "CANCELLING",
+  Active: "ACTIVE",
+} as const;
+export type ReportStatusResponseStatus = ClosedEnum<
+  typeof ReportStatusResponseStatus
+>;
+
+export type ReportStatusResponse = {
+  status?: ReportStatusResponseStatus | undefined;
+  /**
+   * The timestamp at which the report's run/scan began.
+   */
+  startTime?: string | undefined;
+};
+
+/** @internal */
+export const ReportStatusResponseStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ReportStatusResponseStatus
+> = z.nativeEnum(ReportStatusResponseStatus);
+
+/** @internal */
+export const ReportStatusResponseStatus$outboundSchema: z.ZodNativeEnum<
+  typeof ReportStatusResponseStatus
+> = ReportStatusResponseStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ReportStatusResponseStatus$ {
+  /** @deprecated use `ReportStatusResponseStatus$inboundSchema` instead. */
+  export const inboundSchema = ReportStatusResponseStatus$inboundSchema;
+  /** @deprecated use `ReportStatusResponseStatus$outboundSchema` instead. */
+  export const outboundSchema = ReportStatusResponseStatus$outboundSchema;
+}
+
+/** @internal */
+export const ReportStatusResponse$inboundSchema: z.ZodType<
+  ReportStatusResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: ReportStatusResponseStatus$inboundSchema.optional(),
+  startTime: z.string().optional(),
+});
+
+/** @internal */
+export type ReportStatusResponse$Outbound = {
+  status?: string | undefined;
+  startTime?: string | undefined;
+};
+
+/** @internal */
+export const ReportStatusResponse$outboundSchema: z.ZodType<
+  ReportStatusResponse$Outbound,
+  z.ZodTypeDef,
+  ReportStatusResponse
+> = z.object({
+  status: ReportStatusResponseStatus$outboundSchema.optional(),
+  startTime: 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 ReportStatusResponse$ {
+  /** @deprecated use `ReportStatusResponse$inboundSchema` instead. */
+  export const inboundSchema = ReportStatusResponse$inboundSchema;
+  /** @deprecated use `ReportStatusResponse$outboundSchema` instead. */
+  export const outboundSchema = ReportStatusResponse$outboundSchema;
+  /** @deprecated use `ReportStatusResponse$Outbound` instead. */
+  export type Outbound = ReportStatusResponse$Outbound;
+}
+
+export function reportStatusResponseToJSON(
+  reportStatusResponse: ReportStatusResponse,
+): string {
+  return JSON.stringify(
+    ReportStatusResponse$outboundSchema.parse(reportStatusResponse),
+  );
+}
+
+export function reportStatusResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ReportStatusResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReportStatusResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReportStatusResponse' from JSON`,
+  );
+}

package/src/models/components/searchagentsrequest.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 SearchAgentsRequest = {
+  /**
+   * Filters on the name of the agent. If empty, acts as no filter.
+   */
+  name?: string | undefined;
+};
+
+/** @internal */
+export const SearchAgentsRequest$inboundSchema: z.ZodType<
+  SearchAgentsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+});
+
+/** @internal */
+export type SearchAgentsRequest$Outbound = {
+  name?: string | undefined;
+};
+
+/** @internal */
+export const SearchAgentsRequest$outboundSchema: z.ZodType<
+  SearchAgentsRequest$Outbound,
+  z.ZodTypeDef,
+  SearchAgentsRequest
+> = z.object({
+  name: 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 SearchAgentsRequest$ {
+  /** @deprecated use `SearchAgentsRequest$inboundSchema` instead. */
+  export const inboundSchema = SearchAgentsRequest$inboundSchema;
+  /** @deprecated use `SearchAgentsRequest$outboundSchema` instead. */
+  export const outboundSchema = SearchAgentsRequest$outboundSchema;
+  /** @deprecated use `SearchAgentsRequest$Outbound` instead. */
+  export type Outbound = SearchAgentsRequest$Outbound;
+}
+
+export function searchAgentsRequestToJSON(
+  searchAgentsRequest: SearchAgentsRequest,
+): string {
+  return JSON.stringify(
+    SearchAgentsRequest$outboundSchema.parse(searchAgentsRequest),
+  );
+}
+
+export function searchAgentsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchAgentsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchAgentsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchAgentsRequest' from JSON`,
+  );
+}

package/src/models/components/searchagentsresponse.ts

@@ -0,0 +1,72 @@
+/*
+ * 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 {
+  Agent,
+  Agent$inboundSchema,
+  Agent$Outbound,
+  Agent$outboundSchema,
+} from "./agent.js";
+
+export type SearchAgentsResponse = {
+  agents?: Array<Agent> | undefined;
+};
+
+/** @internal */
+export const SearchAgentsResponse$inboundSchema: z.ZodType<
+  SearchAgentsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agents: z.array(Agent$inboundSchema).optional(),
+});
+
+/** @internal */
+export type SearchAgentsResponse$Outbound = {
+  agents?: Array<Agent$Outbound> | undefined;
+};
+
+/** @internal */
+export const SearchAgentsResponse$outboundSchema: z.ZodType<
+  SearchAgentsResponse$Outbound,
+  z.ZodTypeDef,
+  SearchAgentsResponse
+> = z.object({
+  agents: z.array(Agent$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 SearchAgentsResponse$ {
+  /** @deprecated use `SearchAgentsResponse$inboundSchema` instead. */
+  export const inboundSchema = SearchAgentsResponse$inboundSchema;
+  /** @deprecated use `SearchAgentsResponse$outboundSchema` instead. */
+  export const outboundSchema = SearchAgentsResponse$outboundSchema;
+  /** @deprecated use `SearchAgentsResponse$Outbound` instead. */
+  export type Outbound = SearchAgentsResponse$Outbound;
+}
+
+export function searchAgentsResponseToJSON(
+  searchAgentsResponse: SearchAgentsResponse,
+): string {
+  return JSON.stringify(
+    SearchAgentsResponse$outboundSchema.parse(searchAgentsResponse),
+  );
+}
+
+export function searchAgentsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchAgentsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchAgentsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchAgentsResponse' from JSON`,
+  );
+}

package/src/models/components/security.ts

@@ -3,13 +3,13 @@
  */
 
 import * as z from "zod";
-import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Security = {
-  apiToken?: string | undefined;
+  actAsBearerToken?: string | undefined;
+  cookieAuth?: string | undefined;
 };
 
 /** @internal */
@@ -18,16 +18,14 @@ export const Security$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  APIToken: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "APIToken": "apiToken",
-  });
+  actAsBearerToken: z.string().optional(),
+  cookieAuth: z.string().optional(),
 });
 
 /** @internal */
 export type Security$Outbound = {
-  APIToken?: string | undefined;
+  actAsBearerToken?: string | undefined;
+  cookieAuth?: string | undefined;
 };
 
 /** @internal */
@@ -36,11 +34,8 @@ export const Security$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Security
 > = z.object({
-  apiToken: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    apiToken: "APIToken",
-  });
+  actAsBearerToken: z.string().optional(),
+  cookieAuth: z.string().optional(),
 });
 
 /**

package/src/models/components/sensitivecontentoptions.ts

@@ -0,0 +1,98 @@
+/*
+ * 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 {
+  SensitiveExpression,
+  SensitiveExpression$inboundSchema,
+  SensitiveExpression$Outbound,
+  SensitiveExpression$outboundSchema,
+} from "./sensitiveexpression.js";
+import {
+  SensitiveInfoType,
+  SensitiveInfoType$inboundSchema,
+  SensitiveInfoType$Outbound,
+  SensitiveInfoType$outboundSchema,
+} from "./sensitiveinfotype.js";
+
+/**
+ * Options for defining sensitive content within scanned documents.
+ */
+export type SensitiveContentOptions = {
+  /**
+   * Predefined categories of terms to consider as sensitive content. See https://cloud.google.com/dlp/docs/infotypes-reference for available types.
+   */
+  sensitiveInfoTypes?: Array<SensitiveInfoType> | undefined;
+  /**
+   * list of words and phrases to consider as sensitive content
+   */
+  sensitiveTerms?: Array<SensitiveExpression> | undefined;
+  /**
+   * list of regular expressions to consider as sensitive content
+   */
+  sensitiveRegexes?: Array<SensitiveExpression> | undefined;
+};
+
+/** @internal */
+export const SensitiveContentOptions$inboundSchema: z.ZodType<
+  SensitiveContentOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sensitiveInfoTypes: z.array(SensitiveInfoType$inboundSchema).optional(),
+  sensitiveTerms: z.array(SensitiveExpression$inboundSchema).optional(),
+  sensitiveRegexes: z.array(SensitiveExpression$inboundSchema).optional(),
+});
+
+/** @internal */
+export type SensitiveContentOptions$Outbound = {
+  sensitiveInfoTypes?: Array<SensitiveInfoType$Outbound> | undefined;
+  sensitiveTerms?: Array<SensitiveExpression$Outbound> | undefined;
+  sensitiveRegexes?: Array<SensitiveExpression$Outbound> | undefined;
+};
+
+/** @internal */
+export const SensitiveContentOptions$outboundSchema: z.ZodType<
+  SensitiveContentOptions$Outbound,
+  z.ZodTypeDef,
+  SensitiveContentOptions
+> = z.object({
+  sensitiveInfoTypes: z.array(SensitiveInfoType$outboundSchema).optional(),
+  sensitiveTerms: z.array(SensitiveExpression$outboundSchema).optional(),
+  sensitiveRegexes: z.array(SensitiveExpression$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 SensitiveContentOptions$ {
+  /** @deprecated use `SensitiveContentOptions$inboundSchema` instead. */
+  export const inboundSchema = SensitiveContentOptions$inboundSchema;
+  /** @deprecated use `SensitiveContentOptions$outboundSchema` instead. */
+  export const outboundSchema = SensitiveContentOptions$outboundSchema;
+  /** @deprecated use `SensitiveContentOptions$Outbound` instead. */
+  export type Outbound = SensitiveContentOptions$Outbound;
+}
+
+export function sensitiveContentOptionsToJSON(
+  sensitiveContentOptions: SensitiveContentOptions,
+): string {
+  return JSON.stringify(
+    SensitiveContentOptions$outboundSchema.parse(sensitiveContentOptions),
+  );
+}
+
+export function sensitiveContentOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<SensitiveContentOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SensitiveContentOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SensitiveContentOptions' from JSON`,
+  );
+}

package/src/models/components/sensitiveexpression.ts

@@ -0,0 +1,82 @@
+/*
+ * 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 {
+  Hotword,
+  Hotword$inboundSchema,
+  Hotword$Outbound,
+  Hotword$outboundSchema,
+} from "./hotword.js";
+
+export type SensitiveExpression = {
+  /**
+   * Sensitive word, phrase, or regular expression.
+   */
+  expression?: string | undefined;
+  /**
+   * Zero to three proximate regular expressions necessary to consider an expression as sensitive content.
+   */
+  hotwords?: Array<Hotword> | undefined;
+};
+
+/** @internal */
+export const SensitiveExpression$inboundSchema: z.ZodType<
+  SensitiveExpression,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  expression: z.string().optional(),
+  hotwords: z.array(Hotword$inboundSchema).optional(),
+});
+
+/** @internal */
+export type SensitiveExpression$Outbound = {
+  expression?: string | undefined;
+  hotwords?: Array<Hotword$Outbound> | undefined;
+};
+
+/** @internal */
+export const SensitiveExpression$outboundSchema: z.ZodType<
+  SensitiveExpression$Outbound,
+  z.ZodTypeDef,
+  SensitiveExpression
+> = z.object({
+  expression: z.string().optional(),
+  hotwords: z.array(Hotword$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 SensitiveExpression$ {
+  /** @deprecated use `SensitiveExpression$inboundSchema` instead. */
+  export const inboundSchema = SensitiveExpression$inboundSchema;
+  /** @deprecated use `SensitiveExpression$outboundSchema` instead. */
+  export const outboundSchema = SensitiveExpression$outboundSchema;
+  /** @deprecated use `SensitiveExpression$Outbound` instead. */
+  export type Outbound = SensitiveExpression$Outbound;
+}
+
+export function sensitiveExpressionToJSON(
+  sensitiveExpression: SensitiveExpression,
+): string {
+  return JSON.stringify(
+    SensitiveExpression$outboundSchema.parse(sensitiveExpression),
+  );
+}
+
+export function sensitiveExpressionFromJSON(
+  jsonString: string,
+): SafeParseResult<SensitiveExpression, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SensitiveExpression$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SensitiveExpression' from JSON`,
+  );
+}

package/src/models/components/sensitiveinfotype.ts

@@ -0,0 +1,110 @@
+/*
+ * 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";
+
+/**
+ * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export const LikelihoodThreshold = {
+  Likely: "LIKELY",
+  VeryLikely: "VERY_LIKELY",
+} as const;
+/**
+ * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export type LikelihoodThreshold = ClosedEnum<typeof LikelihoodThreshold>;
+
+export type SensitiveInfoType = {
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  likelihoodThreshold?: LikelihoodThreshold | undefined;
+  /**
+   * Text representation of an info-type to scan for.
+   */
+  infoType?: string | undefined;
+};
+
+/** @internal */
+export const LikelihoodThreshold$inboundSchema: z.ZodNativeEnum<
+  typeof LikelihoodThreshold
+> = z.nativeEnum(LikelihoodThreshold);
+
+/** @internal */
+export const LikelihoodThreshold$outboundSchema: z.ZodNativeEnum<
+  typeof LikelihoodThreshold
+> = LikelihoodThreshold$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LikelihoodThreshold$ {
+  /** @deprecated use `LikelihoodThreshold$inboundSchema` instead. */
+  export const inboundSchema = LikelihoodThreshold$inboundSchema;
+  /** @deprecated use `LikelihoodThreshold$outboundSchema` instead. */
+  export const outboundSchema = LikelihoodThreshold$outboundSchema;
+}
+
+/** @internal */
+export const SensitiveInfoType$inboundSchema: z.ZodType<
+  SensitiveInfoType,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  likelihoodThreshold: LikelihoodThreshold$inboundSchema.optional(),
+  infoType: z.string().optional(),
+});
+
+/** @internal */
+export type SensitiveInfoType$Outbound = {
+  likelihoodThreshold?: string | undefined;
+  infoType?: string | undefined;
+};
+
+/** @internal */
+export const SensitiveInfoType$outboundSchema: z.ZodType<
+  SensitiveInfoType$Outbound,
+  z.ZodTypeDef,
+  SensitiveInfoType
+> = z.object({
+  likelihoodThreshold: LikelihoodThreshold$outboundSchema.optional(),
+  infoType: 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 SensitiveInfoType$ {
+  /** @deprecated use `SensitiveInfoType$inboundSchema` instead. */
+  export const inboundSchema = SensitiveInfoType$inboundSchema;
+  /** @deprecated use `SensitiveInfoType$outboundSchema` instead. */
+  export const outboundSchema = SensitiveInfoType$outboundSchema;
+  /** @deprecated use `SensitiveInfoType$Outbound` instead. */
+  export type Outbound = SensitiveInfoType$Outbound;
+}
+
+export function sensitiveInfoTypeToJSON(
+  sensitiveInfoType: SensitiveInfoType,
+): string {
+  return JSON.stringify(
+    SensitiveInfoType$outboundSchema.parse(sensitiveInfoType),
+  );
+}
+
+export function sensitiveInfoTypeFromJSON(
+  jsonString: string,
+): SafeParseResult<SensitiveInfoType, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SensitiveInfoType$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SensitiveInfoType' from JSON`,
+  );
+}