@gleanwork/api-client 0.16.1 → 0.17.1

package/src/models/components/platformagentgetresponse.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e38387a46922
+ */
+
+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 { PlatformAgent, PlatformAgent$inboundSchema } from "./platformagent.js";
+
+export type PlatformAgentGetResponse = {
+  agent: PlatformAgent;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformAgentGetResponse$inboundSchema: z.ZodType<
+  PlatformAgentGetResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agent: PlatformAgent$inboundSchema,
+  request_id: z.string(),
+});
+
+export function platformAgentGetResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgentGetResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgentGetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgentGetResponse' from JSON`,
+  );
+}

package/src/models/components/platformagentrun.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b60e7899d3b0
+ */
+
+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 {
+  PlatformAgentExecutionStatus,
+  PlatformAgentExecutionStatus$inboundSchema,
+} from "./platformagentexecutionstatus.js";
+import {
+  PlatformMessage,
+  PlatformMessage$inboundSchema,
+} from "./platformmessage.js";
+
+export type PlatformAgentRun = {
+  /**
+   * ID of the agent being run.
+   */
+  agent_id: string;
+  /**
+   * Input fields for an input-form triggered agent.
+   */
+  input?: { [k: string]: any } | undefined;
+  /**
+   * Messages passed to the agent.
+   */
+  messages?: Array<PlatformMessage> | undefined;
+  /**
+   * Metadata passed to the agent.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * Status of the agent run.
+   */
+  status: PlatformAgentExecutionStatus;
+};
+
+/** @internal */
+export const PlatformAgentRun$inboundSchema: z.ZodType<
+  PlatformAgentRun,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agent_id: z.string(),
+  input: z.record(z.any()).optional(),
+  messages: z.array(PlatformMessage$inboundSchema).optional(),
+  metadata: z.record(z.any()).optional(),
+  status: PlatformAgentExecutionStatus$inboundSchema,
+});
+
+export function platformAgentRunFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgentRun, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgentRun$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgentRun' from JSON`,
+  );
+}

package/src/models/components/platformagentruncreaterequest.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0aaec5605e0b
+ */
+
+import * as z from "zod/v3";
+import {
+  PlatformMessage,
+  PlatformMessage$Outbound,
+  PlatformMessage$outboundSchema,
+} from "./platformmessage.js";
+
+/**
+ * Request to run an agent. A request MUST supply either `messages` (a non-empty conversation) or `input` (for input-form triggered agents).
+ *
+ * @remarks
+ */
+export type PlatformAgentRunCreateRequest = {
+  /**
+   * Input fields for an input-form triggered agent.
+   */
+  input?: { [k: string]: any } | undefined;
+  /**
+   * Messages to pass to the agent. When provided, the array MUST contain at least one message and each message MUST specify a valid `role` and non-empty `content`.
+   *
+   * @remarks
+   */
+  messages?: Array<PlatformMessage> | undefined;
+  /**
+   * Metadata to pass to the agent.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * Whether to stream the run response as server-sent events.
+   */
+  stream?: boolean | undefined;
+};
+
+/** @internal */
+export type PlatformAgentRunCreateRequest$Outbound = {
+  input?: { [k: string]: any } | undefined;
+  messages?: Array<PlatformMessage$Outbound> | undefined;
+  metadata?: { [k: string]: any } | undefined;
+  stream: boolean;
+};
+
+/** @internal */
+export const PlatformAgentRunCreateRequest$outboundSchema: z.ZodType<
+  PlatformAgentRunCreateRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformAgentRunCreateRequest
+> = z.object({
+  input: z.record(z.any()).optional(),
+  messages: z.array(PlatformMessage$outboundSchema).optional(),
+  metadata: z.record(z.any()).optional(),
+  stream: z.boolean().default(false),
+});
+
+export function platformAgentRunCreateRequestToJSON(
+  platformAgentRunCreateRequest: PlatformAgentRunCreateRequest,
+): string {
+  return JSON.stringify(
+    PlatformAgentRunCreateRequest$outboundSchema.parse(
+      platformAgentRunCreateRequest,
+    ),
+  );
+}

package/src/models/components/platformagentrunwaitresponse.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 123f244b0399
+ */
+
+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 {
+  PlatformAgentRun,
+  PlatformAgentRun$inboundSchema,
+} from "./platformagentrun.js";
+import {
+  PlatformMessage,
+  PlatformMessage$inboundSchema,
+} from "./platformmessage.js";
+
+export type PlatformAgentRunWaitResponse = {
+  run?: PlatformAgentRun | undefined;
+  /**
+   * Messages returned by the completed run.
+   */
+  messages?: Array<PlatformMessage> | undefined;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformAgentRunWaitResponse$inboundSchema: z.ZodType<
+  PlatformAgentRunWaitResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  run: PlatformAgentRun$inboundSchema.optional(),
+  messages: z.array(PlatformMessage$inboundSchema).optional(),
+  request_id: z.string(),
+});
+
+export function platformAgentRunWaitResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgentRunWaitResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgentRunWaitResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgentRunWaitResponse' from JSON`,
+  );
+}

package/src/models/components/platformagentschemasresponse.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 68103f28d594
+ */
+
+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 {
+  PlatformActionSummary,
+  PlatformActionSummary$inboundSchema,
+} from "./platformactionsummary.js";
+
+export type PlatformAgentSchemasResponse = {
+  /**
+   * ID of the agent.
+   */
+  agent_id: string;
+  /**
+   * Name of the agent.
+   */
+  name?: string | undefined;
+  /**
+   * Agent input schema in JSON Schema format.
+   */
+  input_schema: { [k: string]: any };
+  /**
+   * Agent output schema in JSON Schema format.
+   */
+  output_schema: { [k: string]: any };
+  /**
+   * Tools that the agent can invoke, when requested.
+   */
+  tools?: Array<PlatformActionSummary> | undefined;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformAgentSchemasResponse$inboundSchema: z.ZodType<
+  PlatformAgentSchemasResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agent_id: z.string(),
+  name: z.string().optional(),
+  input_schema: z.record(z.any()),
+  output_schema: z.record(z.any()),
+  tools: z.array(PlatformActionSummary$inboundSchema).optional(),
+  request_id: z.string(),
+});
+
+export function platformAgentSchemasResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgentSchemasResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgentSchemasResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgentSchemasResponse' from JSON`,
+  );
+}

package/src/models/components/platformagentssearchrequest.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b1d63f2468c7
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformAgentsSearchRequest = {
+  /**
+   * Case-insensitive substring to match against agent names. If omitted or empty, no name filter is applied.
+   */
+  name?: string | undefined;
+};
+
+/** @internal */
+export type PlatformAgentsSearchRequest$Outbound = {
+  name?: string | undefined;
+};
+
+/** @internal */
+export const PlatformAgentsSearchRequest$outboundSchema: z.ZodType<
+  PlatformAgentsSearchRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformAgentsSearchRequest
+> = z.object({
+  name: z.string().optional(),
+});
+
+export function platformAgentsSearchRequestToJSON(
+  platformAgentsSearchRequest: PlatformAgentsSearchRequest,
+): string {
+  return JSON.stringify(
+    PlatformAgentsSearchRequest$outboundSchema.parse(
+      platformAgentsSearchRequest,
+    ),
+  );
+}

package/src/models/components/platformagentssearchresponse.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ce95b592315d
+ */
+
+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 { PlatformAgent, PlatformAgent$inboundSchema } from "./platformagent.js";
+
+export type PlatformAgentsSearchResponse = {
+  /**
+   * Agents matching the search request.
+   */
+  agents: Array<PlatformAgent>;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformAgentsSearchResponse$inboundSchema: z.ZodType<
+  PlatformAgentsSearchResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agents: z.array(PlatformAgent$inboundSchema),
+  request_id: z.string(),
+});
+
+export function platformAgentsSearchResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgentsSearchResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgentsSearchResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgentsSearchResponse' from JSON`,
+  );
+}

package/src/models/components/platformcontenttype.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 982868bad9f7
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const PlatformContentType = {
+  Text: "text",
+} as const;
+export type PlatformContentType = ClosedEnum<typeof PlatformContentType>;
+
+/** @internal */
+export const PlatformContentType$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformContentType
+> = z.nativeEnum(PlatformContentType);
+/** @internal */
+export const PlatformContentType$outboundSchema: z.ZodNativeEnum<
+  typeof PlatformContentType
+> = PlatformContentType$inboundSchema;

package/src/models/components/platformfilter.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 606c0824e0d8
+ */
+
+import * as z from "zod/v3";
+import {
+  PlatformFilterOperator,
+  PlatformFilterOperator$outboundSchema,
+} from "./platformfilteroperator.js";
+
+/**
+ * A single filter criterion. For `EQUALS`, multiple values within a filter are OR'd. For `NOT_EQUALS`, multiple values exclude all listed values. Filters are AND'd with each other and with any inline query operators.
+ *
+ * @remarks
+ */
+export type PlatformFilter = {
+  /**
+   * The field to filter on. Accepts built-in filter field names such as `type`, `owner`, `from`, `author`, `channel`, `status`, `assignee`, `reporter`, `component`, `mentions`, and `collection`, plus custom datasource property names.
+   *
+   * @remarks
+   */
+  field: string;
+  /**
+   * One or more values to match.
+   */
+  values: Array<string>;
+  /**
+   * Comparison operator to apply to this filter. Defaults to `EQUALS`. `GT`, `GTE`, `LT`, and `LTE` range operators require exactly one value; express bounded ranges with multiple filters on the same field.
+   *
+   * @remarks
+   */
+  operator?: PlatformFilterOperator | undefined;
+};
+
+/** @internal */
+export type PlatformFilter$Outbound = {
+  field: string;
+  values: Array<string>;
+  operator?: string | undefined;
+};
+
+/** @internal */
+export const PlatformFilter$outboundSchema: z.ZodType<
+  PlatformFilter$Outbound,
+  z.ZodTypeDef,
+  PlatformFilter
+> = z.object({
+  field: z.string(),
+  values: z.array(z.string()),
+  operator: PlatformFilterOperator$outboundSchema.optional(),
+});
+
+export function platformFilterToJSON(platformFilter: PlatformFilter): string {
+  return JSON.stringify(PlatformFilter$outboundSchema.parse(platformFilter));
+}

package/src/models/components/platformfilteroperator.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4b1aaa52245c
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Supported filter operator.
+ */
+export const PlatformFilterOperator = {
+  Equals: "EQUALS",
+  NotEquals: "NOT_EQUALS",
+  Gt: "GT",
+  Gte: "GTE",
+  Lt: "LT",
+  Lte: "LTE",
+} as const;
+/**
+ * Supported filter operator.
+ */
+export type PlatformFilterOperator = ClosedEnum<typeof PlatformFilterOperator>;
+
+/** @internal */
+export const PlatformFilterOperator$outboundSchema: z.ZodNativeEnum<
+  typeof PlatformFilterOperator
+> = z.nativeEnum(PlatformFilterOperator);

package/src/models/components/platformmessage.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 8869a2cf3a64
+ */
+
+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 {
+  PlatformMessageRole,
+  PlatformMessageRole$inboundSchema,
+  PlatformMessageRole$outboundSchema,
+} from "./platformmessagerole.js";
+import {
+  PlatformMessageTextBlock,
+  PlatformMessageTextBlock$inboundSchema,
+  PlatformMessageTextBlock$Outbound,
+  PlatformMessageTextBlock$outboundSchema,
+} from "./platformmessagetextblock.js";
+
+export type PlatformMessage = {
+  /**
+   * Role of the message author.
+   */
+  role: PlatformMessageRole;
+  /**
+   * Content blocks in the message.
+   */
+  content: Array<PlatformMessageTextBlock>;
+};
+
+/** @internal */
+export const PlatformMessage$inboundSchema: z.ZodType<
+  PlatformMessage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  role: PlatformMessageRole$inboundSchema,
+  content: z.array(PlatformMessageTextBlock$inboundSchema),
+});
+/** @internal */
+export type PlatformMessage$Outbound = {
+  role: string;
+  content: Array<PlatformMessageTextBlock$Outbound>;
+};
+
+/** @internal */
+export const PlatformMessage$outboundSchema: z.ZodType<
+  PlatformMessage$Outbound,
+  z.ZodTypeDef,
+  PlatformMessage
+> = z.object({
+  role: PlatformMessageRole$outboundSchema,
+  content: z.array(PlatformMessageTextBlock$outboundSchema),
+});
+
+export function platformMessageToJSON(
+  platformMessage: PlatformMessage,
+): string {
+  return JSON.stringify(PlatformMessage$outboundSchema.parse(platformMessage));
+}
+export function platformMessageFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformMessage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformMessage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformMessage' from JSON`,
+  );
+}

package/src/models/components/platformmessagerole.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0ab40c0f07e5
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Role of the message author.
+ */
+export const PlatformMessageRole = {
+  User: "USER",
+  GleanAi: "GLEAN_AI",
+} as const;
+/**
+ * Role of the message author.
+ */
+export type PlatformMessageRole = OpenEnum<typeof PlatformMessageRole>;
+
+/** @internal */
+export const PlatformMessageRole$inboundSchema: z.ZodType<
+  PlatformMessageRole,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlatformMessageRole);
+/** @internal */
+export const PlatformMessageRole$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  PlatformMessageRole
+> = openEnums.outboundSchema(PlatformMessageRole);

package/src/models/components/platformmessagetextblock.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 04c29072e98c
+ */
+
+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 {
+  PlatformContentType,
+  PlatformContentType$inboundSchema,
+  PlatformContentType$outboundSchema,
+} from "./platformcontenttype.js";
+
+export type PlatformMessageTextBlock = {
+  /**
+   * Text content.
+   */
+  text: string;
+  type: PlatformContentType;
+};
+
+/** @internal */
+export const PlatformMessageTextBlock$inboundSchema: z.ZodType<
+  PlatformMessageTextBlock,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  text: z.string(),
+  type: PlatformContentType$inboundSchema,
+});
+/** @internal */
+export type PlatformMessageTextBlock$Outbound = {
+  text: string;
+  type: string;
+};
+
+/** @internal */
+export const PlatformMessageTextBlock$outboundSchema: z.ZodType<
+  PlatformMessageTextBlock$Outbound,
+  z.ZodTypeDef,
+  PlatformMessageTextBlock
+> = z.object({
+  text: z.string(),
+  type: PlatformContentType$outboundSchema,
+});
+
+export function platformMessageTextBlockToJSON(
+  platformMessageTextBlock: PlatformMessageTextBlock,
+): string {
+  return JSON.stringify(
+    PlatformMessageTextBlock$outboundSchema.parse(platformMessageTextBlock),
+  );
+}
+export function platformMessageTextBlockFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformMessageTextBlock, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformMessageTextBlock$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformMessageTextBlock' from JSON`,
+  );
+}

package/src/models/components/platformpersonreference.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: bea88114dd5e
+ */
+
+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";
+
+/**
+ * A lightweight reference to a person, used where a payload merely points at someone.
+ */
+export type PlatformPersonReference = {
+  /**
+   * Opaque Glean person ID.
+   */
+  id?: string | undefined;
+  /**
+   * Display name.
+   */
+  name: string;
+};
+
+/** @internal */
+export const PlatformPersonReference$inboundSchema: z.ZodType<
+  PlatformPersonReference,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  name: z.string(),
+});
+
+export function platformPersonReferenceFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformPersonReference, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformPersonReference$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformPersonReference' from JSON`,
+  );
+}