@gleanwork/api-client 0.18.0 → 0.19.0

package/src/models/components/platformchatcitationsource.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 630cf5fea155
+ */
+
+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 {
+  PlatformChatCustomEntitySource,
+  PlatformChatCustomEntitySource$inboundSchema,
+} from "./platformchatcustomentitysource.js";
+import {
+  PlatformChatDocumentSource,
+  PlatformChatDocumentSource$inboundSchema,
+} from "./platformchatdocumentsource.js";
+import {
+  PlatformChatFileSource,
+  PlatformChatFileSource$inboundSchema,
+} from "./platformchatfilesource.js";
+import {
+  PlatformChatPersonSource,
+  PlatformChatPersonSource$inboundSchema,
+} from "./platformchatpersonsource.js";
+
+/**
+ * Four-variant citation source union.
+ */
+export type PlatformChatCitationSource =
+  | (PlatformChatDocumentSource & { type: "DOCUMENT" })
+  | PlatformChatPersonSource
+  | PlatformChatFileSource
+  | PlatformChatCustomEntitySource;
+
+/** @internal */
+export const PlatformChatCitationSource$inboundSchema: z.ZodType<
+  PlatformChatCitationSource,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  PlatformChatDocumentSource$inboundSchema.and(
+    z.object({ type: z.literal("DOCUMENT") }),
+  ),
+  PlatformChatPersonSource$inboundSchema,
+  PlatformChatFileSource$inboundSchema,
+  PlatformChatCustomEntitySource$inboundSchema,
+]);
+
+export function platformChatCitationSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatCitationSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformChatCitationSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatCitationSource' from JSON`,
+  );
+}

package/src/models/components/platformchatcompletedresponse.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: dd026ef73bb1
+ */
+
+import * as z from "zod/v3";
+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 {
+  PlatformChatOutputMessage,
+  PlatformChatOutputMessage$inboundSchema,
+} from "./platformchatoutputmessage.js";
+
+export const ObjectT = {
+  Response: "RESPONSE",
+} as const;
+export type ObjectT = ClosedEnum<typeof ObjectT>;
+
+export const PlatformChatCompletedResponseStatus = {
+  Completed: "COMPLETED",
+} as const;
+export type PlatformChatCompletedResponseStatus = ClosedEnum<
+  typeof PlatformChatCompletedResponseStatus
+>;
+
+export type PlatformChatCompletedResponse = {
+  /**
+   * Platform-owned, non-persisted response envelope identifier in `resp_<uuid>` form. The same identifier is used for every event in one streamed response.
+   *
+   * @remarks
+   */
+  id: string;
+  object: ObjectT;
+  /**
+   * RFC 3339 UTC timestamp when the response was created.
+   */
+  created_at: Date;
+  status: PlatformChatCompletedResponseStatus;
+  output: Array<PlatformChatOutputMessage>;
+  store: boolean;
+  /**
+   * Present when the interaction was persisted.
+   */
+  conversation_id?: string | null | undefined;
+  request_id: string;
+};
+
+/** @internal */
+export const ObjectT$inboundSchema: z.ZodNativeEnum<typeof ObjectT> = z
+  .nativeEnum(ObjectT);
+
+/** @internal */
+export const PlatformChatCompletedResponseStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformChatCompletedResponseStatus
+> = z.nativeEnum(PlatformChatCompletedResponseStatus);
+
+/** @internal */
+export const PlatformChatCompletedResponse$inboundSchema: z.ZodType<
+  PlatformChatCompletedResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  object: ObjectT$inboundSchema,
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  status: PlatformChatCompletedResponseStatus$inboundSchema,
+  output: z.array(PlatformChatOutputMessage$inboundSchema),
+  store: z.boolean(),
+  conversation_id: z.nullable(z.string()).optional(),
+  request_id: z.string(),
+});
+
+export function platformChatCompletedResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatCompletedResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformChatCompletedResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatCompletedResponse' from JSON`,
+  );
+}

package/src/models/components/platformchatcreaterequest.ts

@@ -0,0 +1,90 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a0537d504f7f
+ */
+
+import * as z from "zod/v3";
+import {
+  PlatformChatInputMessage,
+  PlatformChatInputMessage$Outbound,
+  PlatformChatInputMessage$outboundSchema,
+} from "./platformchatinputmessage.js";
+
+/**
+ * Either a plain string (single user turn) or a chronological array of `USER`/`ASSISTANT` messages. The final array message must be `USER`.
+ *
+ * @remarks
+ */
+export type Input = string | Array<PlatformChatInputMessage>;
+
+export type PlatformChatCreateRequest = {
+  /**
+   * Either a plain string (single user turn) or a chronological array of `USER`/`ASSISTANT` messages. The final array message must be `USER`.
+   *
+   * @remarks
+   */
+  input: string | Array<PlatformChatInputMessage>;
+  /**
+   * When true, respond with `text/event-stream`. When false or omitted, respond with `application/json`.
+   *
+   * @remarks
+   */
+  stream?: boolean | undefined;
+  /**
+   * When true (default), persist the interaction and return a `conversation_id`. When false, run ephemerally with no persistence.
+   *
+   * @remarks
+   */
+  store?: boolean | undefined;
+  /**
+   * Continue an existing stored conversation. Incompatible with message-array `input` and with `store: false`.
+   *
+   * @remarks
+   */
+  conversation_id?: string | undefined;
+};
+
+/** @internal */
+export type Input$Outbound = string | Array<PlatformChatInputMessage$Outbound>;
+
+/** @internal */
+export const Input$outboundSchema: z.ZodType<
+  Input$Outbound,
+  z.ZodTypeDef,
+  Input
+> = z.union([z.string(), z.array(PlatformChatInputMessage$outboundSchema)]);
+
+export function inputToJSON(input: Input): string {
+  return JSON.stringify(Input$outboundSchema.parse(input));
+}
+
+/** @internal */
+export type PlatformChatCreateRequest$Outbound = {
+  input: string | Array<PlatformChatInputMessage$Outbound>;
+  stream: boolean;
+  store: boolean;
+  conversation_id?: string | undefined;
+};
+
+/** @internal */
+export const PlatformChatCreateRequest$outboundSchema: z.ZodType<
+  PlatformChatCreateRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformChatCreateRequest
+> = z.object({
+  input: z.union([
+    z.string(),
+    z.array(PlatformChatInputMessage$outboundSchema),
+  ]),
+  stream: z.boolean().default(false),
+  store: z.boolean().default(true),
+  conversation_id: z.string().optional(),
+});
+
+export function platformChatCreateRequestToJSON(
+  platformChatCreateRequest: PlatformChatCreateRequest,
+): string {
+  return JSON.stringify(
+    PlatformChatCreateRequest$outboundSchema.parse(platformChatCreateRequest),
+  );
+}

package/src/models/components/platformchatcustomentitysource.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 30d921035e09
+ */
+
+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 PlatformChatCustomEntitySource = {
+  type: "CUSTOM_ENTITY";
+  entity_id: string;
+  name?: string | undefined;
+  title?: string | undefined;
+  url?: string | undefined;
+  datasource?: string | undefined;
+};
+
+/** @internal */
+export const PlatformChatCustomEntitySource$inboundSchema: z.ZodType<
+  PlatformChatCustomEntitySource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("CUSTOM_ENTITY"),
+  entity_id: z.string(),
+  name: z.string().optional(),
+  title: z.string().optional(),
+  url: z.string().optional(),
+  datasource: z.string().optional(),
+});
+
+export function platformChatCustomEntitySourceFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatCustomEntitySource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformChatCustomEntitySource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatCustomEntitySource' from JSON`,
+  );
+}

package/src/models/components/platformchatdocumentsource.ts

@@ -0,0 +1,122 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d8ca12507aee
+ */
+
+import * as z from "zod/v3";
+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 PlatformChatDocumentSourceType2 = {
+  Document: "DOCUMENT",
+} as const;
+export type PlatformChatDocumentSourceType2 = ClosedEnum<
+  typeof PlatformChatDocumentSourceType2
+>;
+
+export type PlatformChatDocumentSourceDocument2 = {
+  type: PlatformChatDocumentSourceType2;
+  document_id?: string | undefined;
+  url: string;
+  title?: string | undefined;
+  datasource?: string | undefined;
+};
+
+export const PlatformChatDocumentSourceType1 = {
+  Document: "DOCUMENT",
+} as const;
+export type PlatformChatDocumentSourceType1 = ClosedEnum<
+  typeof PlatformChatDocumentSourceType1
+>;
+
+export type PlatformChatDocumentSourceDocument1 = {
+  type: PlatformChatDocumentSourceType1;
+  document_id: string;
+  url?: string | undefined;
+  title?: string | undefined;
+  datasource?: string | undefined;
+};
+
+export type PlatformChatDocumentSource =
+  | PlatformChatDocumentSourceDocument1
+  | PlatformChatDocumentSourceDocument2;
+
+/** @internal */
+export const PlatformChatDocumentSourceType2$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformChatDocumentSourceType2
+> = z.nativeEnum(PlatformChatDocumentSourceType2);
+
+/** @internal */
+export const PlatformChatDocumentSourceDocument2$inboundSchema: z.ZodType<
+  PlatformChatDocumentSourceDocument2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PlatformChatDocumentSourceType2$inboundSchema,
+  document_id: z.string().optional(),
+  url: z.string(),
+  title: z.string().optional(),
+  datasource: z.string().optional(),
+});
+
+export function platformChatDocumentSourceDocument2FromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatDocumentSourceDocument2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlatformChatDocumentSourceDocument2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatDocumentSourceDocument2' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlatformChatDocumentSourceType1$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformChatDocumentSourceType1
+> = z.nativeEnum(PlatformChatDocumentSourceType1);
+
+/** @internal */
+export const PlatformChatDocumentSourceDocument1$inboundSchema: z.ZodType<
+  PlatformChatDocumentSourceDocument1,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PlatformChatDocumentSourceType1$inboundSchema,
+  document_id: z.string(),
+  url: z.string().optional(),
+  title: z.string().optional(),
+  datasource: z.string().optional(),
+});
+
+export function platformChatDocumentSourceDocument1FromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatDocumentSourceDocument1, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlatformChatDocumentSourceDocument1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatDocumentSourceDocument1' from JSON`,
+  );
+}
+
+/** @internal */
+export const PlatformChatDocumentSource$inboundSchema: z.ZodType<
+  PlatformChatDocumentSource,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => PlatformChatDocumentSourceDocument1$inboundSchema),
+  z.lazy(() => PlatformChatDocumentSourceDocument2$inboundSchema),
+]);
+
+export function platformChatDocumentSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatDocumentSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformChatDocumentSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatDocumentSource' from JSON`,
+  );
+}

package/src/models/components/platformchatfilesource.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 25059e755130
+ */
+
+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 PlatformChatFileSource = {
+  type: "FILE";
+  file_id: string;
+  title?: string | undefined;
+  url?: string | undefined;
+  datasource?: string | undefined;
+};
+
+/** @internal */
+export const PlatformChatFileSource$inboundSchema: z.ZodType<
+  PlatformChatFileSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("FILE"),
+  file_id: z.string(),
+  title: z.string().optional(),
+  url: z.string().optional(),
+  datasource: z.string().optional(),
+});
+
+export function platformChatFileSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatFileSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformChatFileSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatFileSource' from JSON`,
+  );
+}

package/src/models/components/platformchatinputmessage.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3cfc29b0d268
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const PlatformChatInputMessageRole = {
+  User: "USER",
+  Assistant: "ASSISTANT",
+} as const;
+export type PlatformChatInputMessageRole = ClosedEnum<
+  typeof PlatformChatInputMessageRole
+>;
+
+export type PlatformChatInputMessage = {
+  role: PlatformChatInputMessageRole;
+  content: string;
+};
+
+/** @internal */
+export const PlatformChatInputMessageRole$outboundSchema: z.ZodNativeEnum<
+  typeof PlatformChatInputMessageRole
+> = z.nativeEnum(PlatformChatInputMessageRole);
+
+/** @internal */
+export type PlatformChatInputMessage$Outbound = {
+  role: string;
+  content: string;
+};
+
+/** @internal */
+export const PlatformChatInputMessage$outboundSchema: z.ZodType<
+  PlatformChatInputMessage$Outbound,
+  z.ZodTypeDef,
+  PlatformChatInputMessage
+> = z.object({
+  role: PlatformChatInputMessageRole$outboundSchema,
+  content: z.string(),
+});
+
+export function platformChatInputMessageToJSON(
+  platformChatInputMessage: PlatformChatInputMessage,
+): string {
+  return JSON.stringify(
+    PlatformChatInputMessage$outboundSchema.parse(platformChatInputMessage),
+  );
+}

package/src/models/components/platformchatoutputmessage.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 99912ae2c54e
+ */
+
+import * as z from "zod/v3";
+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 {
+  PlatformChatOutputTextContent,
+  PlatformChatOutputTextContent$inboundSchema,
+} from "./platformchatoutputtextcontent.js";
+
+export const PlatformChatOutputMessageType = {
+  Message: "MESSAGE",
+} as const;
+export type PlatformChatOutputMessageType = ClosedEnum<
+  typeof PlatformChatOutputMessageType
+>;
+
+export const PlatformChatOutputMessageRole = {
+  Assistant: "ASSISTANT",
+} as const;
+export type PlatformChatOutputMessageRole = ClosedEnum<
+  typeof PlatformChatOutputMessageRole
+>;
+
+export type PlatformChatOutputMessage = {
+  type: PlatformChatOutputMessageType;
+  role: PlatformChatOutputMessageRole;
+  content: Array<PlatformChatOutputTextContent>;
+};
+
+/** @internal */
+export const PlatformChatOutputMessageType$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformChatOutputMessageType
+> = z.nativeEnum(PlatformChatOutputMessageType);
+
+/** @internal */
+export const PlatformChatOutputMessageRole$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformChatOutputMessageRole
+> = z.nativeEnum(PlatformChatOutputMessageRole);
+
+/** @internal */
+export const PlatformChatOutputMessage$inboundSchema: z.ZodType<
+  PlatformChatOutputMessage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PlatformChatOutputMessageType$inboundSchema,
+  role: PlatformChatOutputMessageRole$inboundSchema,
+  content: z.array(PlatformChatOutputTextContent$inboundSchema),
+});
+
+export function platformChatOutputMessageFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatOutputMessage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformChatOutputMessage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatOutputMessage' from JSON`,
+  );
+}

package/src/models/components/platformchatoutputtextcontent.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: aef245149405
+ */
+
+import * as z from "zod/v3";
+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 {
+  PlatformChatCitationAnnotation,
+  PlatformChatCitationAnnotation$inboundSchema,
+} from "./platformchatcitationannotation.js";
+
+export const PlatformChatOutputTextContentType = {
+  OutputText: "OUTPUT_TEXT",
+} as const;
+export type PlatformChatOutputTextContentType = ClosedEnum<
+  typeof PlatformChatOutputTextContentType
+>;
+
+export type PlatformChatOutputTextContent = {
+  type: PlatformChatOutputTextContentType;
+  text: string;
+  annotations?: Array<PlatformChatCitationAnnotation> | undefined;
+};
+
+/** @internal */
+export const PlatformChatOutputTextContentType$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformChatOutputTextContentType
+> = z.nativeEnum(PlatformChatOutputTextContentType);
+
+/** @internal */
+export const PlatformChatOutputTextContent$inboundSchema: z.ZodType<
+  PlatformChatOutputTextContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PlatformChatOutputTextContentType$inboundSchema,
+  text: z.string(),
+  annotations: z.array(PlatformChatCitationAnnotation$inboundSchema).optional(),
+});
+
+export function platformChatOutputTextContentFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatOutputTextContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformChatOutputTextContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatOutputTextContent' from JSON`,
+  );
+}

package/src/models/components/platformchatpersonsource.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9e78924ff10b
+ */
+
+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 PlatformChatPersonSource = {
+  type: "PERSON";
+  person_id: string;
+  name?: string | undefined;
+  url?: string | undefined;
+};
+
+/** @internal */
+export const PlatformChatPersonSource$inboundSchema: z.ZodType<
+  PlatformChatPersonSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("PERSON"),
+  person_id: z.string(),
+  name: z.string().optional(),
+  url: z.string().optional(),
+});
+
+export function platformChatPersonSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatPersonSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformChatPersonSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatPersonSource' from JSON`,
+  );
+}