@gleanwork/api-client 0.16.1 → 0.17.1

package/src/models/operations/getagent.ts

@@ -4,7 +4,6 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
 
 export type GetAgentRequest = {
   /**
@@ -18,7 +17,7 @@ export type GetAgentRequest = {
   /**
    * The ID of the agent.
    */
-  agentId: string;
+  agent_id: string;
 };
 
 /** @internal */
@@ -36,11 +35,7 @@ export const GetAgentRequest$outboundSchema: z.ZodType<
 > = z.object({
   locale: z.string().optional(),
   timezoneOffset: z.number().int().optional(),
-  agentId: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    agentId: "agent_id",
-  });
+  agent_id: z.string(),
 });
 
 export function getAgentRequestToJSON(

package/src/models/operations/getagentschemas.ts

@@ -4,7 +4,6 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
 
 export type GetAgentSchemasRequest = {
   /**
@@ -18,7 +17,7 @@ export type GetAgentSchemasRequest = {
   /**
    * The ID of the agent.
    */
-  agentId: string;
+  agent_id: string;
 };
 
 /** @internal */
@@ -36,11 +35,7 @@ export const GetAgentSchemasRequest$outboundSchema: z.ZodType<
 > = z.object({
   locale: z.string().optional(),
   timezoneOffset: z.number().int().optional(),
-  agentId: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    agentId: "agent_id",
-  });
+  agent_id: z.string(),
 });
 
 export function getAgentSchemasRequestToJSON(

package/src/models/operations/getpersonphoto.ts

@@ -13,7 +13,7 @@ export type GetPersonPhotoRequest = {
   /**
    * The obfuscated ID of the person whose photo to retrieve.
    */
-  personId: string;
+  person_id: string;
   /**
    * Optional datasource override for crawled photos (e.g. AZURE, GDRIVE, OKTA). When omitted, the datasource is derived from the person's stored photo URL or the deployment's primary person datasource.
    *
@@ -27,7 +27,7 @@ export type GetPersonPhotoResponseResult =
   | ReadableStream<Uint8Array>;
 
 export type GetPersonPhotoResponse = {
-  headers: { [k: string]: Array<string> };
+  Headers: { [k: string]: Array<string> };
   result: ReadableStream<Uint8Array> | ReadableStream<Uint8Array>;
 };
 
@@ -43,12 +43,8 @@ export const GetPersonPhotoRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetPersonPhotoRequest
 > = z.object({
-  personId: z.string(),
+  person_id: z.string(),
   ds: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    personId: "person_id",
-  });
 });
 
 export function getPersonPhotoRequestToJSON(
@@ -92,7 +88,6 @@ export const GetPersonPhotoResponse$inboundSchema: z.ZodType<
   ]),
 }).transform((v) => {
   return remap$(v, {
-    "Headers": "headers",
     "Result": "result",
   });
 });

package/src/models/operations/index.ts

@@ -70,6 +70,9 @@ export * from "./listverifications.js";
 export * from "./messages.js";
 export * from "./people.js";
 export * from "./pin.js";
+export * from "./platformagentscreaterun.js";
+export * from "./platformagentsget.js";
+export * from "./platformagentsgetschemas.js";
 export * from "./postapiindexv1debugdatasourcedocument.js";
 export * from "./postapiindexv1debugdatasourcedocumentevents.js";
 export * from "./postapiindexv1debugdatasourcedocuments.js";

package/src/models/operations/platformagentscreaterun.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 51a44ec04f7d
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PlatformAgentsCreateRunRequest = {
+  /**
+   * ID of the agent to run.
+   */
+  agent_id: string;
+  platformAgentRunCreateRequest: components.PlatformAgentRunCreateRequest;
+};
+
+export type PlatformAgentsCreateRunResponse =
+  | components.PlatformAgentRunWaitResponse
+  | string;
+
+/** @internal */
+export type PlatformAgentsCreateRunRequest$Outbound = {
+  agent_id: string;
+  PlatformAgentRunCreateRequest:
+    components.PlatformAgentRunCreateRequest$Outbound;
+};
+
+/** @internal */
+export const PlatformAgentsCreateRunRequest$outboundSchema: z.ZodType<
+  PlatformAgentsCreateRunRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformAgentsCreateRunRequest
+> = z.object({
+  agent_id: z.string(),
+  platformAgentRunCreateRequest:
+    components.PlatformAgentRunCreateRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    platformAgentRunCreateRequest: "PlatformAgentRunCreateRequest",
+  });
+});
+
+export function platformAgentsCreateRunRequestToJSON(
+  platformAgentsCreateRunRequest: PlatformAgentsCreateRunRequest,
+): string {
+  return JSON.stringify(
+    PlatformAgentsCreateRunRequest$outboundSchema.parse(
+      platformAgentsCreateRunRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const PlatformAgentsCreateRunResponse$inboundSchema: z.ZodType<
+  PlatformAgentsCreateRunResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  components.PlatformAgentRunWaitResponse$inboundSchema,
+  z.string(),
+]);
+
+export function platformAgentsCreateRunResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgentsCreateRunResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgentsCreateRunResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgentsCreateRunResponse' from JSON`,
+  );
+}

package/src/models/operations/platformagentsget.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a1a38c3fd799
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformAgentsGetRequest = {
+  /**
+   * ID of the agent to retrieve.
+   */
+  agent_id: string;
+};
+
+/** @internal */
+export type PlatformAgentsGetRequest$Outbound = {
+  agent_id: string;
+};
+
+/** @internal */
+export const PlatformAgentsGetRequest$outboundSchema: z.ZodType<
+  PlatformAgentsGetRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformAgentsGetRequest
+> = z.object({
+  agent_id: z.string(),
+});
+
+export function platformAgentsGetRequestToJSON(
+  platformAgentsGetRequest: PlatformAgentsGetRequest,
+): string {
+  return JSON.stringify(
+    PlatformAgentsGetRequest$outboundSchema.parse(platformAgentsGetRequest),
+  );
+}

package/src/models/operations/platformagentsgetschemas.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c025879102b3
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformAgentsGetSchemasRequest = {
+  /**
+   * ID of the agent whose schemas should be retrieved.
+   */
+  agent_id: string;
+  /**
+   * Whether to include tool metadata in the response.
+   */
+  include_tools?: boolean | undefined;
+};
+
+/** @internal */
+export type PlatformAgentsGetSchemasRequest$Outbound = {
+  agent_id: string;
+  include_tools: boolean;
+};
+
+/** @internal */
+export const PlatformAgentsGetSchemasRequest$outboundSchema: z.ZodType<
+  PlatformAgentsGetSchemasRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformAgentsGetSchemasRequest
+> = z.object({
+  agent_id: z.string(),
+  include_tools: z.boolean().default(false),
+});
+
+export function platformAgentsGetSchemasRequestToJSON(
+  platformAgentsGetSchemasRequest: PlatformAgentsGetSchemasRequest,
+): string {
+  return JSON.stringify(
+    PlatformAgentsGetSchemasRequest$outboundSchema.parse(
+      platformAgentsGetSchemasRequest,
+    ),
+  );
+}

package/src/react-query/agentsCreateRun.ts

@@ -0,0 +1,121 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b1268b5938b6
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import {
+  agentsCreateRun,
+  CreateRunAcceptEnum,
+} from "../funcs/agentsCreateRun.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export { CreateRunAcceptEnum } from "../funcs/agentsCreateRun.js";
+
+export type AgentsCreateRunMutationVariables = {
+  platformAgentRunCreateRequest: components.PlatformAgentRunCreateRequest;
+  agentId: string;
+  options?: RequestOptions & { acceptHeaderOverride?: CreateRunAcceptEnum };
+};
+
+export type AgentsCreateRunMutationData =
+  operations.PlatformAgentsCreateRunResponse;
+
+export type AgentsCreateRunMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Create agent run
+ *
+ * @remarks
+ * Execute an agent run. Set `stream` to true to receive server-sent events; otherwise the response contains the final agent messages.
+ */
+export function useAgentsCreateRunMutation(
+  options?: MutationHookOptions<
+    AgentsCreateRunMutationData,
+    AgentsCreateRunMutationError,
+    AgentsCreateRunMutationVariables
+  >,
+): UseMutationResult<
+  AgentsCreateRunMutationData,
+  AgentsCreateRunMutationError,
+  AgentsCreateRunMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildAgentsCreateRunMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyAgentsCreateRun(): MutationKey {
+  return ["@gleanwork/api-client", "agents", "createRun"];
+}
+
+export function buildAgentsCreateRunMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions & { acceptHeaderOverride?: CreateRunAcceptEnum },
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: AgentsCreateRunMutationVariables,
+  ) => Promise<AgentsCreateRunMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyAgentsCreateRun(),
+    mutationFn: function agentsCreateRunMutationFn({
+      platformAgentRunCreateRequest,
+      agentId,
+      options,
+    }): Promise<AgentsCreateRunMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(agentsCreateRun(
+        client$,
+        platformAgentRunCreateRequest,
+        agentId,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/agentsGet.core.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: bf202f112850
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { agentsGet } from "../funcs/agentsGet.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type AgentsGetQueryData = components.PlatformAgentGetResponse;
+
+export function prefetchAgentsGet(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  agentId: string,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildAgentsGetQuery(
+      client$,
+      agentId,
+      options,
+    ),
+  });
+}
+
+export function buildAgentsGetQuery(
+  client$: GleanCore,
+  agentId: string,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (context: QueryFunctionContext) => Promise<AgentsGetQueryData>;
+} {
+  return {
+    queryKey: queryKeyAgentsGet(agentId),
+    queryFn: async function agentsGetQueryFn(ctx): Promise<AgentsGetQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(agentsGet(
+        client$,
+        agentId,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyAgentsGet(agentId: string): QueryKey {
+  return ["@gleanwork/api-client", "agents", "get", agentId];
+}

package/src/react-query/agentsGet.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9dfa72974fdb
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { useGleanContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  AgentsGetQueryData,
+  buildAgentsGetQuery,
+  prefetchAgentsGet,
+  queryKeyAgentsGet,
+} from "./agentsGet.core.js";
+export {
+  type AgentsGetQueryData,
+  buildAgentsGetQuery,
+  prefetchAgentsGet,
+  queryKeyAgentsGet,
+};
+
+export type AgentsGetQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get agent
+ *
+ * @remarks
+ * Retrieve details for an agent available to the authenticated user.
+ */
+export function useAgentsGet(
+  agentId: string,
+  options?: QueryHookOptions<AgentsGetQueryData, AgentsGetQueryError>,
+): UseQueryResult<AgentsGetQueryData, AgentsGetQueryError> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildAgentsGetQuery(
+      client,
+      agentId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get agent
+ *
+ * @remarks
+ * Retrieve details for an agent available to the authenticated user.
+ */
+export function useAgentsGetSuspense(
+  agentId: string,
+  options?: SuspenseQueryHookOptions<AgentsGetQueryData, AgentsGetQueryError>,
+): UseSuspenseQueryResult<AgentsGetQueryData, AgentsGetQueryError> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildAgentsGetQuery(
+      client,
+      agentId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setAgentsGetData(
+  client: QueryClient,
+  queryKeyBase: [agentId: string],
+  data: AgentsGetQueryData,
+): AgentsGetQueryData | undefined {
+  const key = queryKeyAgentsGet(...queryKeyBase);
+
+  return client.setQueryData<AgentsGetQueryData>(key, data);
+}
+
+export function invalidateAgentsGet(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[agentId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "agents", "get", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllAgentsGet(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "agents", "get"],
+  });
+}

package/src/react-query/agentsGetSchemas.core.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: fcd506067f82
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { agentsGetSchemas } from "../funcs/agentsGetSchemas.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type AgentsGetSchemasQueryData = components.PlatformAgentSchemasResponse;
+
+export function prefetchAgentsGetSchemas(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  agentId: string,
+  includeTools?: boolean | undefined,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildAgentsGetSchemasQuery(
+      client$,
+      agentId,
+      includeTools,
+      options,
+    ),
+  });
+}
+
+export function buildAgentsGetSchemasQuery(
+  client$: GleanCore,
+  agentId: string,
+  includeTools?: boolean | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<AgentsGetSchemasQueryData>;
+} {
+  return {
+    queryKey: queryKeyAgentsGetSchemas(agentId, { includeTools }),
+    queryFn: async function agentsGetSchemasQueryFn(
+      ctx,
+    ): Promise<AgentsGetSchemasQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(agentsGetSchemas(
+        client$,
+        agentId,
+        includeTools,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyAgentsGetSchemas(
+  agentId: string,
+  parameters: { includeTools?: boolean | undefined },
+): QueryKey {
+  return ["@gleanwork/api-client", "agents", "getSchemas", agentId, parameters];
+}