@gleanwork/api-client 0.17.2 → 0.17.3

package/src/models/components/servertoolrequest.ts

@@ -0,0 +1,138 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: cac47cd90cd3
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ActionPreview,
+  ActionPreview$inboundSchema,
+  ActionPreview$Outbound,
+  ActionPreview$outboundSchema,
+} from "./actionpreview.js";
+
+/**
+ * The type of request made to the user.
+ */
+export const ServerToolRequestRequestType = {
+  /**
+   * Request for approving execution of the tool.
+   */
+  Execution: "EXECUTION",
+  /**
+   * Request for authenticating to a tool, provided as a (tool) suggestion.
+   */
+  AuthenticationSuggestion: "AUTHENTICATION_SUGGESTION",
+  /**
+   * Suggestion to vote for enabling an available-but-not-enabled tool.
+   */
+  VoteSuggestion: "VOTE_SUGGESTION",
+} as const;
+/**
+ * The type of request made to the user.
+ */
+export type ServerToolRequestRequestType = OpenEnum<
+  typeof ServerToolRequestRequestType
+>;
+
+export type ServerToolRequest = {
+  /**
+   * The type of request made to the user.
+   */
+  requestType: ServerToolRequestRequestType;
+  /**
+   * Unique identifier for this request.
+   */
+  requestId: string;
+  /**
+   * Human-readable display name for the tool.
+   */
+  toolDisplayName?: string | undefined;
+  /**
+   * Unique identifier of the tool server. Use with GET /tool-servers/{serverId}/auth
+   *
+   * @remarks
+   * to resolve display information and authentication status.
+   */
+  serverId?: string | undefined;
+  /**
+   * Custom call-to-action (CTA) verb for the approval button (e.g., "Create", "Update", "Send").
+   */
+  toolCta?: string | undefined;
+  /**
+   * Preview information for an action being executed.
+   */
+  actionPreview?: ActionPreview | undefined;
+};
+
+/** @internal */
+export const ServerToolRequestRequestType$inboundSchema: z.ZodType<
+  ServerToolRequestRequestType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ServerToolRequestRequestType);
+/** @internal */
+export const ServerToolRequestRequestType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ServerToolRequestRequestType
+> = openEnums.outboundSchema(ServerToolRequestRequestType);
+
+/** @internal */
+export const ServerToolRequest$inboundSchema: z.ZodType<
+  ServerToolRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  requestType: ServerToolRequestRequestType$inboundSchema,
+  requestId: z.string(),
+  toolDisplayName: z.string().optional(),
+  serverId: z.string().optional(),
+  toolCta: z.string().optional(),
+  actionPreview: ActionPreview$inboundSchema.optional(),
+});
+/** @internal */
+export type ServerToolRequest$Outbound = {
+  requestType: string;
+  requestId: string;
+  toolDisplayName?: string | undefined;
+  serverId?: string | undefined;
+  toolCta?: string | undefined;
+  actionPreview?: ActionPreview$Outbound | undefined;
+};
+
+/** @internal */
+export const ServerToolRequest$outboundSchema: z.ZodType<
+  ServerToolRequest$Outbound,
+  z.ZodTypeDef,
+  ServerToolRequest
+> = z.object({
+  requestType: ServerToolRequestRequestType$outboundSchema,
+  requestId: z.string(),
+  toolDisplayName: z.string().optional(),
+  serverId: z.string().optional(),
+  toolCta: z.string().optional(),
+  actionPreview: ActionPreview$outboundSchema.optional(),
+});
+
+export function serverToolRequestToJSON(
+  serverToolRequest: ServerToolRequest,
+): string {
+  return JSON.stringify(
+    ServerToolRequest$outboundSchema.parse(serverToolRequest),
+  );
+}
+export function serverToolRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ServerToolRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ServerToolRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ServerToolRequest' from JSON`,
+  );
+}

package/src/models/components/servertoolresponse.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9d3c25ee1ce8
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AuthContext,
+  AuthContext$inboundSchema,
+  AuthContext$Outbound,
+  AuthContext$outboundSchema,
+} from "./authcontext.js";
+
+/**
+ * The type of request made to the user.
+ */
+export const ServerToolResponseRequestType = {
+  /**
+   * Request for approving execution of the tool.
+   */
+  Execution: "EXECUTION",
+  /**
+   * Request for authenticating to a tool, provided as a (tool) suggestion.
+   */
+  AuthenticationSuggestion: "AUTHENTICATION_SUGGESTION",
+  /**
+   * Suggestion to vote for enabling an available-but-not-enabled tool.
+   */
+  VoteSuggestion: "VOTE_SUGGESTION",
+} as const;
+/**
+ * The type of request made to the user.
+ */
+export type ServerToolResponseRequestType = OpenEnum<
+  typeof ServerToolResponseRequestType
+>;
+
+/**
+ * Scope of the approval grant. Only applicable when isGranted is true and requestType is EXECUTION.
+ *
+ * @remarks
+ */
+export const GrantScope = {
+  /**
+   * Approve only the current tool request. Future tool execution requests still require approval.
+   */
+  CurrentRequest: "CURRENT_REQUEST",
+  /**
+   * Approve the current tool request and auto-approve all future same tool requests in this chat session.
+   */
+  CurrentSession: "CURRENT_SESSION",
+  /**
+   * Approve the current tool request and auto-approve all future same tool requests across all chat sessions.
+   */
+  Always: "ALWAYS",
+} as const;
+/**
+ * Scope of the approval grant. Only applicable when isGranted is true and requestType is EXECUTION.
+ *
+ * @remarks
+ */
+export type GrantScope = OpenEnum<typeof GrantScope>;
+
+/**
+ * Response to a server tool request. The applicable fields depend on requestType:
+ *
+ * @remarks
+ *
+ * For EXECUTION requests:
+ * - isGranted: whether tool execution is approved
+ * - reason: optional explanation
+ *
+ * For AUTHENTICATION_SUGGESTION requests:
+ * - isGranted: whether auth completed successfully (true=connected, false=skipped)
+ * - authContext: contains serverId or actionPackId for identifying the authenticated entity
+ * - reason: optional explanation for skip
+ *
+ * For VOTE_SUGGESTION requests:
+ * - voted: whether the user voted for this tool
+ */
+export type ServerToolResponse = {
+  /**
+   * The type of request made to the user.
+   */
+  requestType: ServerToolResponseRequestType;
+  /**
+   * Unique identifier for this request.
+   */
+  requestId: string;
+  /**
+   * Whether tool request is granted (indicates approval for execution, or completion for auth).
+   */
+  isGranted?: boolean | undefined;
+  /**
+   * Scope of the approval grant. Only applicable when isGranted is true and requestType is EXECUTION.
+   *
+   * @remarks
+   */
+  grantScope?: GrantScope | undefined;
+  /**
+   * Context for authentication responses, containing identifiers for the entity being authenticated.
+   *
+   * @remarks
+   */
+  authContext?: AuthContext | undefined;
+};
+
+/** @internal */
+export const ServerToolResponseRequestType$inboundSchema: z.ZodType<
+  ServerToolResponseRequestType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ServerToolResponseRequestType);
+/** @internal */
+export const ServerToolResponseRequestType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ServerToolResponseRequestType
+> = openEnums.outboundSchema(ServerToolResponseRequestType);
+
+/** @internal */
+export const GrantScope$inboundSchema: z.ZodType<
+  GrantScope,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GrantScope);
+/** @internal */
+export const GrantScope$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  GrantScope
+> = openEnums.outboundSchema(GrantScope);
+
+/** @internal */
+export const ServerToolResponse$inboundSchema: z.ZodType<
+  ServerToolResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  requestType: ServerToolResponseRequestType$inboundSchema,
+  requestId: z.string(),
+  isGranted: z.boolean().optional(),
+  grantScope: GrantScope$inboundSchema.default("CURRENT_REQUEST"),
+  authContext: AuthContext$inboundSchema.optional(),
+});
+/** @internal */
+export type ServerToolResponse$Outbound = {
+  requestType: string;
+  requestId: string;
+  isGranted?: boolean | undefined;
+  grantScope: string;
+  authContext?: AuthContext$Outbound | undefined;
+};
+
+/** @internal */
+export const ServerToolResponse$outboundSchema: z.ZodType<
+  ServerToolResponse$Outbound,
+  z.ZodTypeDef,
+  ServerToolResponse
+> = z.object({
+  requestType: ServerToolResponseRequestType$outboundSchema,
+  requestId: z.string(),
+  isGranted: z.boolean().optional(),
+  grantScope: GrantScope$outboundSchema.default("CURRENT_REQUEST"),
+  authContext: AuthContext$outboundSchema.optional(),
+});
+
+export function serverToolResponseToJSON(
+  serverToolResponse: ServerToolResponse,
+): string {
+  return JSON.stringify(
+    ServerToolResponse$outboundSchema.parse(serverToolResponse),
+  );
+}
+export function serverToolResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ServerToolResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ServerToolResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ServerToolResponse' from JSON`,
+  );
+}