@gleanwork/api-client 0.4.2 → 0.4.4

package/src/funcs/clientToolsRun.ts

@@ -0,0 +1,154 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { GleanError } from "../models/errors/gleanerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Execute the specified tool
+ *
+ * @remarks
+ * Execute the specified tool with provided parameters
+ */
+export function clientToolsRun(
+  client: GleanCore,
+  request: components.ToolsCallRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.ToolsCallResponse,
+    | GleanError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  request: components.ToolsCallRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.ToolsCallResponse,
+      | GleanError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.ToolsCallRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/rest/api/v1/tools/call")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "post_/rest/api/v1/tools/call",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "404", "429", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    components.ToolsCallResponse,
+    | GleanError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.ToolsCallResponse$inboundSchema),
+    M.fail([400, 401, 404, 429, "4XX"]),
+    M.fail("5XX"),
+  )(response);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -64,8 +64,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.9.0",
-  sdkVersion: "0.4.2",
-  genVersion: "2.604.4",
+  sdkVersion: "0.4.4",
+  genVersion: "2.610.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.4.2 2.604.4 0.9.0 @gleanwork/api-client",
+    "speakeasy-sdk/typescript 0.4.4 2.610.0 0.9.0 @gleanwork/api-client",
 } as const;

package/src/models/components/agentrun.ts

@@ -19,11 +19,6 @@ import {
   Message$outboundSchema,
 } from "./message.js";
 
-/**
- * The input to the agent.
- */
-export type AgentRunInput = {};
-
 /**
  * Payload for creating a run.
  */
@@ -35,7 +30,7 @@ export type AgentRun = {
   /**
    * The input to the agent.
    */
-  input?: AgentRunInput | undefined;
+  input?: { [k: string]: any } | undefined;
   /**
    * The messages to pass an input to the agent.
    */
@@ -46,50 +41,6 @@ export type AgentRun = {
   status?: AgentExecutionStatus | undefined;
 };
 
-/** @internal */
-export const AgentRunInput$inboundSchema: z.ZodType<
-  AgentRunInput,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-/** @internal */
-export type AgentRunInput$Outbound = {};
-
-/** @internal */
-export const AgentRunInput$outboundSchema: z.ZodType<
-  AgentRunInput$Outbound,
-  z.ZodTypeDef,
-  AgentRunInput
-> = z.object({});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace AgentRunInput$ {
-  /** @deprecated use `AgentRunInput$inboundSchema` instead. */
-  export const inboundSchema = AgentRunInput$inboundSchema;
-  /** @deprecated use `AgentRunInput$outboundSchema` instead. */
-  export const outboundSchema = AgentRunInput$outboundSchema;
-  /** @deprecated use `AgentRunInput$Outbound` instead. */
-  export type Outbound = AgentRunInput$Outbound;
-}
-
-export function agentRunInputToJSON(agentRunInput: AgentRunInput): string {
-  return JSON.stringify(AgentRunInput$outboundSchema.parse(agentRunInput));
-}
-
-export function agentRunInputFromJSON(
-  jsonString: string,
-): SafeParseResult<AgentRunInput, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AgentRunInput$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AgentRunInput' from JSON`,
-  );
-}
-
 /** @internal */
 export const AgentRun$inboundSchema: z.ZodType<
   AgentRun,
@@ -97,7 +48,7 @@ export const AgentRun$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   agent_id: z.string().optional(),
-  input: z.lazy(() => AgentRunInput$inboundSchema).optional(),
+  input: z.record(z.any()).optional(),
   messages: z.array(Message$inboundSchema).optional(),
   status: AgentExecutionStatus$inboundSchema.optional(),
 }).transform((v) => {
@@ -109,7 +60,7 @@ export const AgentRun$inboundSchema: z.ZodType<
 /** @internal */
 export type AgentRun$Outbound = {
   agent_id?: string | undefined;
-  input?: AgentRunInput$Outbound | undefined;
+  input?: { [k: string]: any } | undefined;
   messages?: Array<Message$Outbound> | undefined;
   status?: string | undefined;
 };
@@ -121,7 +72,7 @@ export const AgentRun$outboundSchema: z.ZodType<
   AgentRun
 > = z.object({
   agentId: z.string().optional(),
-  input: z.lazy(() => AgentRunInput$outboundSchema).optional(),
+  input: z.record(z.any()).optional(),
   messages: z.array(Message$outboundSchema).optional(),
   status: AgentExecutionStatus$outboundSchema.optional(),
 }).transform((v) => {

package/src/models/components/agentruncreate.ts

@@ -14,11 +14,6 @@ import {
   Message$outboundSchema,
 } from "./message.js";
 
-/**
- * The input to the agent.
- */
-export type AgentRunCreateInput = {};
-
 /**
  * Payload for creating a run.
  */
@@ -30,61 +25,13 @@ export type AgentRunCreate = {
   /**
    * The input to the agent.
    */
-  input?: AgentRunCreateInput | undefined;
+  input?: { [k: string]: any } | undefined;
   /**
    * The messages to pass an input to the agent.
    */
   messages?: Array<Message> | undefined;
 };
 
-/** @internal */
-export const AgentRunCreateInput$inboundSchema: z.ZodType<
-  AgentRunCreateInput,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-/** @internal */
-export type AgentRunCreateInput$Outbound = {};
-
-/** @internal */
-export const AgentRunCreateInput$outboundSchema: z.ZodType<
-  AgentRunCreateInput$Outbound,
-  z.ZodTypeDef,
-  AgentRunCreateInput
-> = z.object({});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace AgentRunCreateInput$ {
-  /** @deprecated use `AgentRunCreateInput$inboundSchema` instead. */
-  export const inboundSchema = AgentRunCreateInput$inboundSchema;
-  /** @deprecated use `AgentRunCreateInput$outboundSchema` instead. */
-  export const outboundSchema = AgentRunCreateInput$outboundSchema;
-  /** @deprecated use `AgentRunCreateInput$Outbound` instead. */
-  export type Outbound = AgentRunCreateInput$Outbound;
-}
-
-export function agentRunCreateInputToJSON(
-  agentRunCreateInput: AgentRunCreateInput,
-): string {
-  return JSON.stringify(
-    AgentRunCreateInput$outboundSchema.parse(agentRunCreateInput),
-  );
-}
-
-export function agentRunCreateInputFromJSON(
-  jsonString: string,
-): SafeParseResult<AgentRunCreateInput, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AgentRunCreateInput$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AgentRunCreateInput' from JSON`,
-  );
-}
-
 /** @internal */
 export const AgentRunCreate$inboundSchema: z.ZodType<
   AgentRunCreate,
@@ -92,7 +39,7 @@ export const AgentRunCreate$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   agent_id: z.string().optional(),
-  input: z.lazy(() => AgentRunCreateInput$inboundSchema).optional(),
+  input: z.record(z.any()).optional(),
   messages: z.array(Message$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -103,7 +50,7 @@ export const AgentRunCreate$inboundSchema: z.ZodType<
 /** @internal */
 export type AgentRunCreate$Outbound = {
   agent_id?: string | undefined;
-  input?: AgentRunCreateInput$Outbound | undefined;
+  input?: { [k: string]: any } | undefined;
   messages?: Array<Message$Outbound> | undefined;
 };
 
@@ -114,7 +61,7 @@ export const AgentRunCreate$outboundSchema: z.ZodType<
   AgentRunCreate
 > = z.object({
   agentId: z.string().optional(),
-  input: z.lazy(() => AgentRunCreateInput$outboundSchema).optional(),
+  input: z.record(z.any()).optional(),
   messages: z.array(Message$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/index.ts

@@ -366,8 +366,14 @@ export * from "./thumbnail.js";
 export * from "./timeinterval.js";
 export * from "./timepoint.js";
 export * from "./timerange.js";
+export * from "./tool.js";
 export * from "./toolinfo.js";
 export * from "./toolmetadata.js";
+export * from "./toolparameter.js";
+export * from "./toolscallparameter.js";
+export * from "./toolscallrequest.js";
+export * from "./toolscallresponse.js";
+export * from "./toolslistresponse.js";
 export * from "./ugctype.js";
 export * from "./unpin.js";
 export * from "./updateannouncementrequest.js";

package/src/models/components/textrange.ts

@@ -17,6 +17,7 @@ import {
 export const TextRangeType = {
   Bold: "BOLD",
   Citation: "CITATION",
+  Highlight: "HIGHLIGHT",
   Link: "LINK",
 } as const;
 export type TextRangeType = ClosedEnum<typeof TextRangeType>;

package/src/models/components/tool.ts

@@ -0,0 +1,125 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  ToolParameter,
+  ToolParameter$inboundSchema,
+  ToolParameter$Outbound,
+  ToolParameter$outboundSchema,
+} from "./toolparameter.js";
+
+/**
+ * Type of tool (READ, WRITE)
+ */
+export const ToolType = {
+  Read: "READ",
+  Write: "WRITE",
+} as const;
+/**
+ * Type of tool (READ, WRITE)
+ */
+export type ToolType = ClosedEnum<typeof ToolType>;
+
+export type Tool = {
+  /**
+   * Type of tool (READ, WRITE)
+   */
+  type?: ToolType | undefined;
+  /**
+   * Unique identifier for the tool
+   */
+  name?: string | undefined;
+  /**
+   * Human-readable name
+   */
+  displayName?: string | undefined;
+  /**
+   * LLM friendly description of the tool
+   */
+  description?: string | undefined;
+  /**
+   * The parameters for the tool. Each key is the name of the parameter and the value is the parameter object.
+   */
+  parameters?: { [k: string]: ToolParameter } | undefined;
+};
+
+/** @internal */
+export const ToolType$inboundSchema: z.ZodNativeEnum<typeof ToolType> = z
+  .nativeEnum(ToolType);
+
+/** @internal */
+export const ToolType$outboundSchema: z.ZodNativeEnum<typeof ToolType> =
+  ToolType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolType$ {
+  /** @deprecated use `ToolType$inboundSchema` instead. */
+  export const inboundSchema = ToolType$inboundSchema;
+  /** @deprecated use `ToolType$outboundSchema` instead. */
+  export const outboundSchema = ToolType$outboundSchema;
+}
+
+/** @internal */
+export const Tool$inboundSchema: z.ZodType<Tool, z.ZodTypeDef, unknown> = z
+  .object({
+    type: ToolType$inboundSchema.optional(),
+    name: z.string().optional(),
+    displayName: z.string().optional(),
+    description: z.string().optional(),
+    parameters: z.record(ToolParameter$inboundSchema).optional(),
+  });
+
+/** @internal */
+export type Tool$Outbound = {
+  type?: string | undefined;
+  name?: string | undefined;
+  displayName?: string | undefined;
+  description?: string | undefined;
+  parameters?: { [k: string]: ToolParameter$Outbound } | undefined;
+};
+
+/** @internal */
+export const Tool$outboundSchema: z.ZodType<Tool$Outbound, z.ZodTypeDef, Tool> =
+  z.object({
+    type: ToolType$outboundSchema.optional(),
+    name: z.string().optional(),
+    displayName: z.string().optional(),
+    description: z.string().optional(),
+    parameters: z.record(ToolParameter$outboundSchema).optional(),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Tool$ {
+  /** @deprecated use `Tool$inboundSchema` instead. */
+  export const inboundSchema = Tool$inboundSchema;
+  /** @deprecated use `Tool$outboundSchema` instead. */
+  export const outboundSchema = Tool$outboundSchema;
+  /** @deprecated use `Tool$Outbound` instead. */
+  export type Outbound = Tool$Outbound;
+}
+
+export function toolToJSON(tool: Tool): string {
+  return JSON.stringify(Tool$outboundSchema.parse(tool));
+}
+
+export function toolFromJSON(
+  jsonString: string,
+): SafeParseResult<Tool, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Tool$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Tool' from JSON`,
+  );
+}

package/src/models/components/toolparameter.ts

@@ -0,0 +1,141 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+
+/**
+ * Parameter type (string, number, boolean, object, array)
+ */
+export const ToolParameterType = {
+  String: "string",
+  Number: "number",
+  Boolean: "boolean",
+  Object: "object",
+  Array: "array",
+} as const;
+/**
+ * Parameter type (string, number, boolean, object, array)
+ */
+export type ToolParameterType = ClosedEnum<typeof ToolParameterType>;
+
+export type ToolParameter = {
+  /**
+   * Parameter type (string, number, boolean, object, array)
+   */
+  type?: ToolParameterType | undefined;
+  /**
+   * The name of the parameter
+   */
+  name?: string | undefined;
+  /**
+   * The description of the parameter
+   */
+  description?: string | undefined;
+  /**
+   * Whether the parameter is required
+   */
+  isRequired?: boolean | undefined;
+  /**
+   * The possible values for the parameter. Can contain only primitive values or arrays of primitive values.
+   */
+  possibleValues?: Array<string> | undefined;
+  items?: ToolParameter | undefined;
+  /**
+   * When type is 'object', this describes the structure of the object.
+   */
+  properties?: { [k: string]: ToolParameter } | undefined;
+};
+
+/** @internal */
+export const ToolParameterType$inboundSchema: z.ZodNativeEnum<
+  typeof ToolParameterType
+> = z.nativeEnum(ToolParameterType);
+
+/** @internal */
+export const ToolParameterType$outboundSchema: z.ZodNativeEnum<
+  typeof ToolParameterType
+> = ToolParameterType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolParameterType$ {
+  /** @deprecated use `ToolParameterType$inboundSchema` instead. */
+  export const inboundSchema = ToolParameterType$inboundSchema;
+  /** @deprecated use `ToolParameterType$outboundSchema` instead. */
+  export const outboundSchema = ToolParameterType$outboundSchema;
+}
+
+/** @internal */
+export const ToolParameter$inboundSchema: z.ZodType<
+  ToolParameter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: ToolParameterType$inboundSchema.optional(),
+  name: z.string().optional(),
+  description: z.string().optional(),
+  isRequired: z.boolean().optional(),
+  possibleValues: z.array(z.string()).optional(),
+  items: z.lazy(() => ToolParameter$inboundSchema).optional(),
+  properties: z.record(z.lazy(() => ToolParameter$inboundSchema)).optional(),
+});
+
+/** @internal */
+export type ToolParameter$Outbound = {
+  type?: string | undefined;
+  name?: string | undefined;
+  description?: string | undefined;
+  isRequired?: boolean | undefined;
+  possibleValues?: Array<string> | undefined;
+  items?: ToolParameter$Outbound | undefined;
+  properties?: { [k: string]: ToolParameter$Outbound } | undefined;
+};
+
+/** @internal */
+export const ToolParameter$outboundSchema: z.ZodType<
+  ToolParameter$Outbound,
+  z.ZodTypeDef,
+  ToolParameter
+> = z.object({
+  type: ToolParameterType$outboundSchema.optional(),
+  name: z.string().optional(),
+  description: z.string().optional(),
+  isRequired: z.boolean().optional(),
+  possibleValues: z.array(z.string()).optional(),
+  items: z.lazy(() => ToolParameter$outboundSchema).optional(),
+  properties: z.record(z.lazy(() => ToolParameter$outboundSchema)).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolParameter$ {
+  /** @deprecated use `ToolParameter$inboundSchema` instead. */
+  export const inboundSchema = ToolParameter$inboundSchema;
+  /** @deprecated use `ToolParameter$outboundSchema` instead. */
+  export const outboundSchema = ToolParameter$outboundSchema;
+  /** @deprecated use `ToolParameter$Outbound` instead. */
+  export type Outbound = ToolParameter$Outbound;
+}
+
+export function toolParameterToJSON(toolParameter: ToolParameter): string {
+  return JSON.stringify(ToolParameter$outboundSchema.parse(toolParameter));
+}
+
+export function toolParameterFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolParameter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolParameter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolParameter' from JSON`,
+  );
+}