@gleanwork/api-client 0.18.0 → 0.18.1

package/src/models/components/index.ts

@@ -3,6 +3,7 @@
  * @generated-id: 0aa842dce54d
  */
 
+export * from "./accessrequestpermissiondeniedresponseerror.js";
 export * from "./actionauthtype.js";
 export * from "./actionpackauthstatus.js";
 export * from "./actionpackauthstatusresponse.js";
@@ -277,6 +278,10 @@ export * from "./grouptype.js";
 export * from "./hotword.js";
 export * from "./hotwordproximity.js";
 export * from "./iconconfig.js";
+export * from "./importagentrequest.js";
+export * from "./importagentresponse.js";
+export * from "./importagentstatus.js";
+export * from "./importagentsyncmode.js";
 export * from "./indexdocumentrequest.js";
 export * from "./indexdocumentsrequest.js";
 export * from "./indexemployeerequest.js";
@@ -355,8 +360,23 @@ export * from "./platformagentrunwaitresponse.js";
 export * from "./platformagentschemasresponse.js";
 export * from "./platformagentssearchrequest.js";
 export * from "./platformagentssearchresponse.js";
+export * from "./platformauthenticationsuggestion.js";
+export * from "./platformchatcitationannotation.js";
+export * from "./platformchatcitationsnippet.js";
+export * from "./platformchatcitationsource.js";
+export * from "./platformchatcompletedresponse.js";
+export * from "./platformchatcreaterequest.js";
+export * from "./platformchatcustomentitysource.js";
+export * from "./platformchatdocumentsource.js";
+export * from "./platformchatfilesource.js";
+export * from "./platformchatinputmessage.js";
+export * from "./platformchatoutputmessage.js";
+export * from "./platformchatoutputtextcontent.js";
+export * from "./platformchatpersonsource.js";
 export * from "./platformcontenttype.js";
+export * from "./platformdatasourcefilterinfo.js";
 export * from "./platformfilter.js";
+export * from "./platformfilterfieldinfo.js";
 export * from "./platformfilteroperator.js";
 export * from "./platformmessage.js";
 export * from "./platformmessagerole.js";
@@ -365,28 +385,42 @@ export * from "./platformpersonreference.js";
 export * from "./platformproblemdetailcode.js";
 export * from "./platformproblemdetailerror.js";
 export * from "./platformresult.js";
+export * from "./platformsearchfiltersresponse.js";
 export * from "./platformsearchrequest.js";
 export * from "./platformsearchresponse.js";
 export * from "./platformskill.js";
 export * from "./platformskillcreaterequest.js";
 export * from "./platformskillcreateresponse.js";
 export * from "./platformskillgetresponse.js";
+export * from "./platformskillimportrequest.js";
+export * from "./platformskillimportresponse.js";
 export * from "./platformskillorigin.js";
 export * from "./platformskillslistresponse.js";
+export * from "./platformskillsourcepreview.js";
+export * from "./platformskillsourcepreviewfailure.js";
+export * from "./platformskillsourcepreviewfailurecode.js";
+export * from "./platformskillsourcepreviewfile.js";
+export * from "./platformskillsourcepreviewrequest.js";
+export * from "./platformskillsourcepreviewresponse.js";
 export * from "./platformskillsourceprovenance.js";
 export * from "./platformskillstatus.js";
+export * from "./platformskillsyncresponse.js";
+export * from "./platformskillsyncresultstatus.js";
 export * from "./platformskillsyncstatus.js";
+export * from "./platformskillupdaterequest.js";
+export * from "./platformskillupdateresponse.js";
+export * from "./platformskillupdatestatus.js";
 export * from "./platformskillvalidationfile.js";
 export * from "./platformskillvalidationmetadata.js";
 export * from "./platformskillvalidationrequest.js";
 export * from "./platformskillvalidationresponse.js";
-export * from "./platformskillvalidationwarning.js";
 export * from "./platformskillversion.js";
 export * from "./platformskillversioncreaterequest.js";
 export * from "./platformskillversioncreateresponse.js";
 export * from "./platformskillversiongetresponse.js";
 export * from "./platformskillversionslistresponse.js";
 export * from "./platformtimerange.js";
+export * from "./platformwarning.js";
 export * from "./possiblevalue.js";
 export * from "./processalldocumentsrequest.js";
 export * from "./processallmembershipsrequest.js";
@@ -469,6 +503,9 @@ export * from "./timepoint.js";
 export * from "./timerange.js";
 export * from "./timerangefilter.js";
 export * from "./tool.js";
+export * from "./toolannotations.js";
+export * from "./tooldefinition.js";
+export * from "./tooldefinitionsresponse.js";
 export * from "./toolinfo.js";
 export * from "./toolmetadata.js";
 export * from "./toolparameter.js";

package/src/models/components/manualfeedbackinfo.ts

@@ -61,6 +61,8 @@ export const Issue = {
   ResultsHelpful: "RESULTS_HELPFUL",
   ResultsPoorOrder: "RESULTS_POOR_ORDER",
   TooMuchOneKind: "TOO_MUCH_ONE_KIND",
+  NotAQuestion: "NOT_A_QUESTION",
+  UnsureIfCorrect: "UNSURE_IF_CORRECT",
 } as const;
 export type Issue = ClosedEnum<typeof Issue>;
 

package/src/models/components/objectdefinition.ts

@@ -44,6 +44,8 @@ export const DocCategory = {
   Entity: "ENTITY",
   Calendar: "CALENDAR",
   Agents: "AGENTS",
+  AiConversation: "AI_CONVERSATION",
+  AiArtifact: "AI_ARTIFACT",
 } as const;
 /**
  * The document category of this object type.

package/src/models/components/personmetadata.ts

@@ -125,6 +125,10 @@ export type PersonMetadata = {
    * An organizational unit where everyone has a similar task, e.g. `Engineering`.
    */
   department?: string | undefined;
+  /**
+   * Normalized job-function category assigned by Entity Builder from the source department and, when available, job title. Unlike `department`, which preserves the company-specific organizational unit, this field groups departments into configured categories such as `Engineering`, `Sales`, or `IT`; it may be `Unknown` when the mapping is inconclusive.
+   */
+  jobFunction?: string | undefined;
   /**
    * Info about the employee's team(s).
    */
@@ -302,6 +306,7 @@ export const PersonMetadata$inboundSchema: z.ZodType<
   title: z.string().optional(),
   businessUnit: z.string().optional(),
   department: z.string().optional(),
+  jobFunction: z.string().optional(),
   teams: z.array(PersonTeam$inboundSchema).optional(),
   departmentCount: z.number().int().optional(),
   email: z.string().optional(),
@@ -352,6 +357,7 @@ export type PersonMetadata$Outbound = {
   title?: string | undefined;
   businessUnit?: string | undefined;
   department?: string | undefined;
+  jobFunction?: string | undefined;
   teams?: Array<PersonTeam$Outbound> | undefined;
   departmentCount?: number | undefined;
   email?: string | undefined;
@@ -405,6 +411,7 @@ export const PersonMetadata$outboundSchema: z.ZodType<
   title: z.string().optional(),
   businessUnit: z.string().optional(),
   department: z.string().optional(),
+  jobFunction: z.string().optional(),
   teams: z.array(PersonTeam$outboundSchema).optional(),
   departmentCount: z.number().int().optional(),
   email: z.string().optional(),

package/src/models/components/platformauthenticationsuggestion.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b7fd21fddef4
+ */
+
+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";
+
+/**
+ * One tool the caller must authorize before the agent can run.
+ */
+export type PlatformAuthenticationSuggestion = {
+  /**
+   * Human-readable tool name.
+   */
+  tool_name?: string | undefined;
+  /**
+   * Identifier to POST to `/tool-servers/{serverId}/auth` (Client API) with `returnUrl` in the request body to obtain an `authorizationUrl` to redirect the end user to.
+   */
+  server_id: string;
+};
+
+/** @internal */
+export const PlatformAuthenticationSuggestion$inboundSchema: z.ZodType<
+  PlatformAuthenticationSuggestion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tool_name: z.string().optional(),
+  server_id: z.string(),
+});
+
+export function platformAuthenticationSuggestionFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAuthenticationSuggestion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAuthenticationSuggestion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAuthenticationSuggestion' from JSON`,
+  );
+}

package/src/models/components/platformchatcitationannotation.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3a01c4a809ce
+ */
+
+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 {
+  PlatformChatCitationSnippet,
+  PlatformChatCitationSnippet$inboundSchema,
+} from "./platformchatcitationsnippet.js";
+import {
+  PlatformChatCitationSource,
+  PlatformChatCitationSource$inboundSchema,
+} from "./platformchatcitationsource.js";
+
+export const PlatformChatCitationAnnotationType = {
+  Citation: "citation",
+} as const;
+export type PlatformChatCitationAnnotationType = ClosedEnum<
+  typeof PlatformChatCitationAnnotationType
+>;
+
+export type PlatformChatCitationAnnotation = {
+  type: PlatformChatCitationAnnotationType;
+  sources: Array<PlatformChatCitationSource>;
+  start_index?: number | null | undefined;
+  end_index?: number | null | undefined;
+  snippets?: Array<PlatformChatCitationSnippet> | null | undefined;
+};
+
+/** @internal */
+export const PlatformChatCitationAnnotationType$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformChatCitationAnnotationType
+> = z.nativeEnum(PlatformChatCitationAnnotationType);
+
+/** @internal */
+export const PlatformChatCitationAnnotation$inboundSchema: z.ZodType<
+  PlatformChatCitationAnnotation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PlatformChatCitationAnnotationType$inboundSchema,
+  sources: z.array(PlatformChatCitationSource$inboundSchema),
+  start_index: z.nullable(z.number().int()).optional(),
+  end_index: z.nullable(z.number().int()).optional(),
+  snippets: z.nullable(z.array(PlatformChatCitationSnippet$inboundSchema))
+    .optional(),
+});
+
+export function platformChatCitationAnnotationFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatCitationAnnotation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformChatCitationAnnotation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatCitationAnnotation' from JSON`,
+  );
+}

package/src/models/components/platformchatcitationsnippet.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 128244b7a174
+ */
+
+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 PlatformChatCitationSnippet = {
+  text: string;
+  page_number?: number | null | undefined;
+};
+
+/** @internal */
+export const PlatformChatCitationSnippet$inboundSchema: z.ZodType<
+  PlatformChatCitationSnippet,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  text: z.string(),
+  page_number: z.nullable(z.number().int()).optional(),
+});
+
+export function platformChatCitationSnippetFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformChatCitationSnippet, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformChatCitationSnippet$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformChatCitationSnippet' from JSON`,
+  );
+}

package/src/models/components/platformchatcitationsource.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 =
+  | PlatformChatPersonSource
+  | PlatformChatFileSource
+  | PlatformChatCustomEntitySource
+  | PlatformChatDocumentSource;
+
+/** @internal */
+export const PlatformChatCitationSource$inboundSchema: z.ZodType<
+  PlatformChatCitationSource,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  PlatformChatPersonSource$inboundSchema,
+  PlatformChatFileSource$inboundSchema,
+  PlatformChatCustomEntitySource$inboundSchema,
+  PlatformChatDocumentSource$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,55 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const PlatformChatCustomEntitySourceType = {
+  CustomEntity: "custom_entity",
+} as const;
+export type PlatformChatCustomEntitySourceType = ClosedEnum<
+  typeof PlatformChatCustomEntitySourceType
+>;
+
+export type PlatformChatCustomEntitySource = {
+  type: PlatformChatCustomEntitySourceType;
+  entity_id: string;
+  name?: string | undefined;
+  title?: string | undefined;
+  url?: string | undefined;
+  datasource?: string | undefined;
+};
+
+/** @internal */
+export const PlatformChatCustomEntitySourceType$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformChatCustomEntitySourceType
+> = z.nativeEnum(PlatformChatCustomEntitySourceType);
+
+/** @internal */
+export const PlatformChatCustomEntitySource$inboundSchema: z.ZodType<
+  PlatformChatCustomEntitySource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: PlatformChatCustomEntitySourceType$inboundSchema,
+  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`,
+  );
+}