@gleanwork/api-client 0.18.0 → 0.18.1

package/src/models/components/{platformskillvalidationwarning.ts → platformwarning.ts}

@@ -1,6 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 9f6d3a564161
+ * @generated-id: 172530a57f1e
  */
 
 import * as z from "zod/v3";
@@ -8,9 +8,14 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type PlatformSkillValidationWarning = {
+/**
+ * Non-blocking warning attached to a successful Platform response.
+ */
+export type PlatformWarning = {
   /**
-   * Stable warning code.
+   * Open snake_case warning code. Clients must tolerate unknown values; the set of codes is not a closed enum.
+   *
+   * @remarks
    */
   code: string;
   /**
@@ -20,8 +25,8 @@ export type PlatformSkillValidationWarning = {
 };
 
 /** @internal */
-export const PlatformSkillValidationWarning$inboundSchema: z.ZodType<
-  PlatformSkillValidationWarning,
+export const PlatformWarning$inboundSchema: z.ZodType<
+  PlatformWarning,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -29,12 +34,12 @@ export const PlatformSkillValidationWarning$inboundSchema: z.ZodType<
   message: z.string(),
 });
 
-export function platformSkillValidationWarningFromJSON(
+export function platformWarningFromJSON(
   jsonString: string,
-): SafeParseResult<PlatformSkillValidationWarning, SDKValidationError> {
+): SafeParseResult<PlatformWarning, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => PlatformSkillValidationWarning$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PlatformSkillValidationWarning' from JSON`,
+    (x) => PlatformWarning$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformWarning' from JSON`,
   );
 }

package/src/models/components/toolannotations.ts

@@ -0,0 +1,77 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d537caae3348
+ */
+
+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";
+
+/**
+ * Behavioural hints for the tool, exactly as declared by the tool server. No
+ *
+ * @remarks
+ * defaults are filled in — see the per-field notes for what an absent value means.
+ *
+ * Per the MCP specification, clients MUST treat these hints as untrusted unless
+ * the tool server is itself trusted. They are advisory metadata, not an
+ * authorization signal, and must not be the sole basis of a security decision.
+ */
+export type ToolAnnotations = {
+  title?: string | undefined;
+  /**
+   * True if the tool does not modify its environment. Always present. MCP
+   *
+   * @remarks
+   * defines no distinction between an undeclared value and `false` here, so
+   * `false` means "not declared read-only" rather than "declared mutating".
+   */
+  readOnlyHint?: boolean | undefined;
+  /**
+   * True if the tool may perform destructive updates. **Absent means the server
+   *
+   * @remarks
+   * did not declare it**, for which the MCP default is `true`. Only meaningful
+   * when `readOnlyHint` is `false`.
+   */
+  destructiveHint?: boolean | null | undefined;
+  /**
+   * True if repeated calls with the same arguments have no additional effect.
+   *
+   * @remarks
+   * Always present; as with `readOnlyHint`, `false` means "not declared
+   * idempotent". Only meaningful when `readOnlyHint` is `false`.
+   */
+  idempotentHint?: boolean | undefined;
+  /**
+   * True if the tool interacts with an open world of external entities. **Absent
+   *
+   * @remarks
+   * means the server did not declare it**, for which the MCP default is `true`.
+   */
+  openWorldHint?: boolean | null | undefined;
+};
+
+/** @internal */
+export const ToolAnnotations$inboundSchema: z.ZodType<
+  ToolAnnotations,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string().optional(),
+  readOnlyHint: z.boolean().optional(),
+  destructiveHint: z.nullable(z.boolean()).optional(),
+  idempotentHint: z.boolean().optional(),
+  openWorldHint: z.nullable(z.boolean()).optional(),
+});
+
+export function toolAnnotationsFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolAnnotations, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolAnnotations$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolAnnotations' from JSON`,
+  );
+}

package/src/models/components/tooldefinition.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e402d1078b0c
+ */
+
+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 {
+  ToolAnnotations,
+  ToolAnnotations$inboundSchema,
+} from "./toolannotations.js";
+
+export type ToolDefinition = {
+  /**
+   * Tool server this tool belongs to.
+   */
+  serverId: string;
+  /**
+   * Name to invoke the tool by.
+   */
+  name: string;
+  /**
+   * Human-readable name of the tool.
+   */
+  displayName?: string | undefined;
+  /**
+   * What the tool does, as surfaced to a model.
+   */
+  description?: string | undefined;
+  /**
+   * JSON Schema for the tool's input parameters.
+   */
+  inputSchema?: { [k: string]: any } | undefined;
+  /**
+   * Behavioural hints for the tool, exactly as declared by the tool server. No
+   *
+   * @remarks
+   * defaults are filled in — see the per-field notes for what an absent value means.
+   *
+   * Per the MCP specification, clients MUST treat these hints as untrusted unless
+   * the tool server is itself trusted. They are advisory metadata, not an
+   * authorization signal, and must not be the sole basis of a security decision.
+   */
+  annotations?: ToolAnnotations | undefined;
+};
+
+/** @internal */
+export const ToolDefinition$inboundSchema: z.ZodType<
+  ToolDefinition,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  serverId: z.string(),
+  name: z.string(),
+  displayName: z.string().optional(),
+  description: z.string().optional(),
+  inputSchema: z.record(z.any()).optional(),
+  annotations: ToolAnnotations$inboundSchema.optional(),
+});
+
+export function toolDefinitionFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolDefinition, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolDefinition$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolDefinition' from JSON`,
+  );
+}

package/src/models/components/tooldefinitionsresponse.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ed5f5c501421
+ */
+
+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 {
+  ToolDefinition,
+  ToolDefinition$inboundSchema,
+} from "./tooldefinition.js";
+
+export type ToolDefinitionsResponse = {
+  /**
+   * Definitions for the requested tools that exist on this server.
+   */
+  tools: Array<ToolDefinition>;
+  /**
+   * Requested names that do not exist on this server.
+   */
+  notFound?: Array<string> | undefined;
+};
+
+/** @internal */
+export const ToolDefinitionsResponse$inboundSchema: z.ZodType<
+  ToolDefinitionsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tools: z.array(ToolDefinition$inboundSchema),
+  notFound: z.array(z.string()).optional(),
+});
+
+export function toolDefinitionsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolDefinitionsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolDefinitionsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolDefinitionsResponse' from JSON`,
+  );
+}

package/src/models/components/viewerinfo.ts

@@ -15,7 +15,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  *
  * @deprecated enum: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use permissions instead.
  */
-export const Role = {
+export const ViewerInfoRole = {
   AnswerModerator: "ANSWER_MODERATOR",
   Owner: "OWNER",
   Viewer: "VIEWER",
@@ -25,7 +25,7 @@ export const Role = {
  *
  * @deprecated enum: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use permissions instead.
  */
-export type Role = OpenEnum<typeof Role>;
+export type ViewerInfoRole = OpenEnum<typeof ViewerInfoRole>;
 
 export type ViewerInfo = {
   /**
@@ -33,16 +33,22 @@ export type ViewerInfo = {
    *
    * @deprecated field: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Use permissions instead.
    */
-  role?: Role | undefined;
+  role?: ViewerInfoRole | undefined;
   lastViewedTime?: Date | undefined;
 };
 
 /** @internal */
-export const Role$inboundSchema: z.ZodType<Role, z.ZodTypeDef, unknown> =
-  openEnums.inboundSchema(Role);
+export const ViewerInfoRole$inboundSchema: z.ZodType<
+  ViewerInfoRole,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ViewerInfoRole);
 /** @internal */
-export const Role$outboundSchema: z.ZodType<string, z.ZodTypeDef, Role> =
-  openEnums.outboundSchema(Role);
+export const ViewerInfoRole$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ViewerInfoRole
+> = openEnums.outboundSchema(ViewerInfoRole);
 
 /** @internal */
 export const ViewerInfo$inboundSchema: z.ZodType<
@@ -50,7 +56,7 @@ export const ViewerInfo$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  role: Role$inboundSchema.optional(),
+  role: ViewerInfoRole$inboundSchema.optional(),
   lastViewedTime: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ).optional(),
@@ -67,7 +73,7 @@ export const ViewerInfo$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ViewerInfo
 > = z.object({
-  role: Role$outboundSchema.optional(),
+  role: ViewerInfoRole$outboundSchema.optional(),
   lastViewedTime: z.date().transform(v => v.toISOString()).optional(),
 });
 

package/src/models/errors/accessrequestpermissiondeniedresponseerror.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 908b092650bb
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+import { GleanBaseError } from "./gleanbaseerror.js";
+
+export type AccessRequestPermissionDeniedResponseErrorData = {
+  errorType: components.AccessRequestPermissionDeniedResponseErrorType;
+  createdBy: components.Person;
+  requestableRoles: Array<components.UserRole>;
+  hasPendingRequest: boolean;
+};
+
+export class AccessRequestPermissionDeniedResponseError extends GleanBaseError {
+  errorType: components.AccessRequestPermissionDeniedResponseErrorType;
+  createdBy: components.Person;
+  requestableRoles: Array<components.UserRole>;
+  hasPendingRequest: boolean;
+
+  /** The original data that was passed to this error instance. */
+  data$: AccessRequestPermissionDeniedResponseErrorData;
+
+  constructor(
+    err: AccessRequestPermissionDeniedResponseErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.errorType = err.errorType;
+    this.createdBy = err.createdBy;
+    this.requestableRoles = err.requestableRoles;
+    this.hasPendingRequest = err.hasPendingRequest;
+
+    this.name = "AccessRequestPermissionDeniedResponseError";
+  }
+}
+
+/** @internal */
+export const AccessRequestPermissionDeniedResponseError$inboundSchema:
+  z.ZodType<AccessRequestPermissionDeniedResponseError, z.ZodTypeDef, unknown> =
+    z.object({
+      errorType:
+        components.AccessRequestPermissionDeniedResponseErrorType$inboundSchema,
+      createdBy: components.Person$inboundSchema,
+      requestableRoles: z.array(components.UserRole$inboundSchema),
+      hasPendingRequest: z.boolean(),
+      request$: z.instanceof(Request),
+      response$: z.instanceof(Response),
+      body$: z.string(),
+    })
+      .transform((v) => {
+        return new AccessRequestPermissionDeniedResponseError(v, {
+          request: v.request$,
+          response: v.response$,
+          body: v.body$,
+        });
+      });

package/src/models/errors/index.ts

@@ -3,6 +3,7 @@
  * @generated-id: c4e22507cb83
  */
 
+export * from "./accessrequestpermissiondeniedresponseerror.js";
 export * from "./collectionerror.js";
 export * from "./errorinforesponse.js";
 export * from "./errorresponse.js";
@@ -11,5 +12,7 @@ export * from "./gleandataerror.js";
 export * from "./gleanerror.js";
 export * from "./httpclienterrors.js";
 export * from "./platformproblemdetailerror.js";
+export * from "./platformunauthorizedagenttoolsproblemerror.js";
 export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";
+export * from "./unauthorizedagenttoolserror.js";

package/src/models/errors/platformunauthorizedagenttoolsproblemerror.ts

@@ -0,0 +1,151 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0bb760d15571
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+import { GleanBaseError } from "./gleanbaseerror.js";
+
+/**
+ * Problem detail extended with `authentication_suggestions` naming each tool the caller must authorize.
+ */
+export type PlatformUnauthorizedAgentToolsProblemErrorData = {
+  /**
+   * URI identifying the error type.
+   */
+  type: string;
+  /**
+   * Short, human-readable summary of the error.
+   */
+  title: string;
+  /**
+   * HTTP status code mirrored from the response.
+   */
+  status: number;
+  /**
+   * Human-readable explanation specific to this occurrence.
+   */
+  detail: string;
+  /**
+   * Stable machine-readable error code.
+   */
+  code: components.PlatformProblemDetailCode;
+  /**
+   * Direct URL to documentation for this error code.
+   */
+  documentation_url?: string | undefined;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+  /**
+   * Field-level validation problems, one entry per offending field.
+   */
+  errors?: Array<components.PlatformProblemDetailError> | undefined;
+  /**
+   * One entry per tool the caller must authorize.
+   */
+  authentication_suggestions: Array<
+    components.PlatformAuthenticationSuggestion
+  >;
+};
+
+/**
+ * Problem detail extended with `authentication_suggestions` naming each tool the caller must authorize.
+ */
+export class PlatformUnauthorizedAgentToolsProblemError extends GleanBaseError {
+  /**
+   * URI identifying the error type.
+   */
+  type: string;
+  /**
+   * Short, human-readable summary of the error.
+   */
+  title: string;
+  /**
+   * HTTP status code mirrored from the response.
+   */
+  status: number;
+  /**
+   * Human-readable explanation specific to this occurrence.
+   */
+  detail: string;
+  /**
+   * Stable machine-readable error code.
+   */
+  code: components.PlatformProblemDetailCode;
+  /**
+   * Direct URL to documentation for this error code.
+   */
+  documentation_url?: string | undefined;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+  /**
+   * Field-level validation problems, one entry per offending field.
+   */
+  errors?: Array<components.PlatformProblemDetailError> | undefined;
+  /**
+   * One entry per tool the caller must authorize.
+   */
+  authentication_suggestions: Array<
+    components.PlatformAuthenticationSuggestion
+  >;
+
+  /** The original data that was passed to this error instance. */
+  data$: PlatformUnauthorizedAgentToolsProblemErrorData;
+
+  constructor(
+    err: PlatformUnauthorizedAgentToolsProblemErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.type = err.type;
+    this.title = err.title;
+    this.status = err.status;
+    this.detail = err.detail;
+    this.code = err.code;
+    if (err.documentation_url != null) {
+      this.documentation_url = err.documentation_url;
+    }
+    this.request_id = err.request_id;
+    if (err.errors != null) this.errors = err.errors;
+    this.authentication_suggestions = err.authentication_suggestions;
+
+    this.name = "PlatformUnauthorizedAgentToolsProblemError";
+  }
+}
+
+/** @internal */
+export const PlatformUnauthorizedAgentToolsProblemError$inboundSchema:
+  z.ZodType<PlatformUnauthorizedAgentToolsProblemError, z.ZodTypeDef, unknown> =
+    z.object({
+      type: z.string(),
+      title: z.string(),
+      status: z.number().int(),
+      detail: z.string(),
+      code: components.PlatformProblemDetailCode$inboundSchema,
+      documentation_url: z.string().optional(),
+      request_id: z.string(),
+      errors: z.array(components.PlatformProblemDetailError$inboundSchema)
+        .optional(),
+      authentication_suggestions: z.array(
+        components.PlatformAuthenticationSuggestion$inboundSchema,
+      ),
+      request$: z.instanceof(Request),
+      response$: z.instanceof(Response),
+      body$: z.string(),
+    })
+      .transform((v) => {
+        return new PlatformUnauthorizedAgentToolsProblemError(v, {
+          request: v.request$,
+          response: v.response$,
+          body: v.body$,
+        });
+      });

package/src/models/errors/unauthorizedagenttoolserror.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9cfc0ed0d054
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+import { GleanBaseError } from "./gleanbaseerror.js";
+
+/**
+ * Returned when the agent has tools the caller must authorize before the run can start. Each entry in `authenticationSuggestions` names one such tool; POST its `serverId` to `/tool-servers/{serverId}/auth` with `returnUrl` in the request body to obtain an `authorizationUrl` to redirect the end user to, then retry the run once OAuth completes.
+ */
+export type UnauthorizedAgentToolsErrorData = {
+  /**
+   * Human-readable description of the failure.
+   */
+  message: string;
+  /**
+   * One entry per tool the caller must authorize.
+   */
+  authenticationSuggestions: Array<components.ServerToolRequest>;
+};
+
+/**
+ * Returned when the agent has tools the caller must authorize before the run can start. Each entry in `authenticationSuggestions` names one such tool; POST its `serverId` to `/tool-servers/{serverId}/auth` with `returnUrl` in the request body to obtain an `authorizationUrl` to redirect the end user to, then retry the run once OAuth completes.
+ */
+export class UnauthorizedAgentToolsError extends GleanBaseError {
+  /**
+   * One entry per tool the caller must authorize.
+   */
+  authenticationSuggestions: Array<components.ServerToolRequest>;
+
+  /** The original data that was passed to this error instance. */
+  data$: UnauthorizedAgentToolsErrorData;
+
+  constructor(
+    err: UnauthorizedAgentToolsErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.authenticationSuggestions = err.authenticationSuggestions;
+
+    this.name = "UnauthorizedAgentToolsError";
+  }
+}
+
+/** @internal */
+export const UnauthorizedAgentToolsError$inboundSchema: z.ZodType<
+  UnauthorizedAgentToolsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string(),
+  authenticationSuggestions: z.array(
+    components.ServerToolRequest$inboundSchema,
+  ),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new UnauthorizedAgentToolsError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/operations/gettoolservertools.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7dbca2be043d
+ */
+
+import * as z from "zod/v3";
+
+export type GetToolServerToolsRequest = {
+  /**
+   * Unique identifier of the tool server.
+   */
+  serverId: string;
+  /**
+   * Tool names to look up on this server. Maximum 100.
+   */
+  toolNames: Array<string>;
+};
+
+/** @internal */
+export type GetToolServerToolsRequest$Outbound = {
+  serverId: string;
+  toolNames: Array<string>;
+};
+
+/** @internal */
+export const GetToolServerToolsRequest$outboundSchema: z.ZodType<
+  GetToolServerToolsRequest$Outbound,
+  z.ZodTypeDef,
+  GetToolServerToolsRequest
+> = z.object({
+  serverId: z.string(),
+  toolNames: z.array(z.string()),
+});
+
+export function getToolServerToolsRequestToJSON(
+  getToolServerToolsRequest: GetToolServerToolsRequest,
+): string {
+  return JSON.stringify(
+    GetToolServerToolsRequest$outboundSchema.parse(getToolServerToolsRequest),
+  );
+}