@gleanwork/api-client 0.2.0 → 0.4.0

package/src/models/components/message.ts

@@ -0,0 +1,136 @@
+/*
+ * 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 {
+  ContentType,
+  ContentType$inboundSchema,
+  ContentType$outboundSchema,
+} from "./contenttype.js";
+
+export type MessageTextBlock = {
+  text: string;
+  type: ContentType;
+};
+
+export type Message = {
+  /**
+   * The role of the message.
+   */
+  role?: string | undefined;
+  /**
+   * The content of the message.
+   */
+  content?: Array<MessageTextBlock> | undefined;
+};
+
+/** @internal */
+export const MessageTextBlock$inboundSchema: z.ZodType<
+  MessageTextBlock,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  text: z.string(),
+  type: ContentType$inboundSchema,
+});
+
+/** @internal */
+export type MessageTextBlock$Outbound = {
+  text: string;
+  type: string;
+};
+
+/** @internal */
+export const MessageTextBlock$outboundSchema: z.ZodType<
+  MessageTextBlock$Outbound,
+  z.ZodTypeDef,
+  MessageTextBlock
+> = z.object({
+  text: z.string(),
+  type: ContentType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MessageTextBlock$ {
+  /** @deprecated use `MessageTextBlock$inboundSchema` instead. */
+  export const inboundSchema = MessageTextBlock$inboundSchema;
+  /** @deprecated use `MessageTextBlock$outboundSchema` instead. */
+  export const outboundSchema = MessageTextBlock$outboundSchema;
+  /** @deprecated use `MessageTextBlock$Outbound` instead. */
+  export type Outbound = MessageTextBlock$Outbound;
+}
+
+export function messageTextBlockToJSON(
+  messageTextBlock: MessageTextBlock,
+): string {
+  return JSON.stringify(
+    MessageTextBlock$outboundSchema.parse(messageTextBlock),
+  );
+}
+
+export function messageTextBlockFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageTextBlock, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageTextBlock$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageTextBlock' from JSON`,
+  );
+}
+
+/** @internal */
+export const Message$inboundSchema: z.ZodType<Message, z.ZodTypeDef, unknown> =
+  z.object({
+    role: z.string().optional(),
+    content: z.array(z.lazy(() => MessageTextBlock$inboundSchema)).optional(),
+  });
+
+/** @internal */
+export type Message$Outbound = {
+  role?: string | undefined;
+  content?: Array<MessageTextBlock$Outbound> | undefined;
+};
+
+/** @internal */
+export const Message$outboundSchema: z.ZodType<
+  Message$Outbound,
+  z.ZodTypeDef,
+  Message
+> = z.object({
+  role: z.string().optional(),
+  content: z.array(z.lazy(() => MessageTextBlock$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 Message$ {
+  /** @deprecated use `Message$inboundSchema` instead. */
+  export const inboundSchema = Message$inboundSchema;
+  /** @deprecated use `Message$outboundSchema` instead. */
+  export const outboundSchema = Message$outboundSchema;
+  /** @deprecated use `Message$Outbound` instead. */
+  export type Outbound = Message$Outbound;
+}
+
+export function messageToJSON(message: Message): string {
+  return JSON.stringify(Message$outboundSchema.parse(message));
+}
+
+export function messageFromJSON(
+  jsonString: string,
+): SafeParseResult<Message, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Message$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Message' from JSON`,
+  );
+}

package/src/models/components/relatedobject.ts

@@ -10,7 +10,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * Some metadata of the object which can be displayed, while not having the actual object.
  */
-export type Metadata = {
+export type RelatedObjectMetadata = {
   /**
    * Placeholder name of the object, not the relationship.
    */
@@ -25,12 +25,12 @@ export type RelatedObject = {
   /**
    * Some metadata of the object which can be displayed, while not having the actual object.
    */
-  metadata?: Metadata | undefined;
+  metadata?: RelatedObjectMetadata | undefined;
 };
 
 /** @internal */
-export const Metadata$inboundSchema: z.ZodType<
-  Metadata,
+export const RelatedObjectMetadata$inboundSchema: z.ZodType<
+  RelatedObjectMetadata,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -38,15 +38,15 @@ export const Metadata$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type Metadata$Outbound = {
+export type RelatedObjectMetadata$Outbound = {
   name?: string | undefined;
 };
 
 /** @internal */
-export const Metadata$outboundSchema: z.ZodType<
-  Metadata$Outbound,
+export const RelatedObjectMetadata$outboundSchema: z.ZodType<
+  RelatedObjectMetadata$Outbound,
   z.ZodTypeDef,
-  Metadata
+  RelatedObjectMetadata
 > = z.object({
   name: z.string().optional(),
 });
@@ -55,26 +55,30 @@ export const Metadata$outboundSchema: z.ZodType<
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace Metadata$ {
-  /** @deprecated use `Metadata$inboundSchema` instead. */
-  export const inboundSchema = Metadata$inboundSchema;
-  /** @deprecated use `Metadata$outboundSchema` instead. */
-  export const outboundSchema = Metadata$outboundSchema;
-  /** @deprecated use `Metadata$Outbound` instead. */
-  export type Outbound = Metadata$Outbound;
+export namespace RelatedObjectMetadata$ {
+  /** @deprecated use `RelatedObjectMetadata$inboundSchema` instead. */
+  export const inboundSchema = RelatedObjectMetadata$inboundSchema;
+  /** @deprecated use `RelatedObjectMetadata$outboundSchema` instead. */
+  export const outboundSchema = RelatedObjectMetadata$outboundSchema;
+  /** @deprecated use `RelatedObjectMetadata$Outbound` instead. */
+  export type Outbound = RelatedObjectMetadata$Outbound;
 }
 
-export function metadataToJSON(metadata: Metadata): string {
-  return JSON.stringify(Metadata$outboundSchema.parse(metadata));
+export function relatedObjectMetadataToJSON(
+  relatedObjectMetadata: RelatedObjectMetadata,
+): string {
+  return JSON.stringify(
+    RelatedObjectMetadata$outboundSchema.parse(relatedObjectMetadata),
+  );
 }
 
-export function metadataFromJSON(
+export function relatedObjectMetadataFromJSON(
   jsonString: string,
-): SafeParseResult<Metadata, SDKValidationError> {
+): SafeParseResult<RelatedObjectMetadata, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Metadata' from JSON`,
+    (x) => RelatedObjectMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RelatedObjectMetadata' from JSON`,
   );
 }
 
@@ -85,13 +89,13 @@ export const RelatedObject$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string(),
-  metadata: z.lazy(() => Metadata$inboundSchema).optional(),
+  metadata: z.lazy(() => RelatedObjectMetadata$inboundSchema).optional(),
 });
 
 /** @internal */
 export type RelatedObject$Outbound = {
   id: string;
-  metadata?: Metadata$Outbound | undefined;
+  metadata?: RelatedObjectMetadata$Outbound | undefined;
 };
 
 /** @internal */
@@ -101,7 +105,7 @@ export const RelatedObject$outboundSchema: z.ZodType<
   RelatedObject
 > = z.object({
   id: z.string(),
-  metadata: z.lazy(() => Metadata$outboundSchema).optional(),
+  metadata: z.lazy(() => RelatedObjectMetadata$outboundSchema).optional(),
 });
 
 /**

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`,
+  );
+}