@gleanwork/api-client 0.4.2 → 0.4.4

package/src/models/components/toolscallparameter.ts

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ToolsCallParameter = {
+  /**
+   * The name of the parameter
+   */
+  name: string;
+  /**
+   * The value of the parameter (for primitive types)
+   */
+  value: string;
+  /**
+   * The value of the parameter (for array types)
+   */
+  items?: Array<ToolsCallParameter> | undefined;
+  /**
+   * The value of the parameter (for object types)
+   */
+  properties?: { [k: string]: ToolsCallParameter } | undefined;
+};
+
+/** @internal */
+export const ToolsCallParameter$inboundSchema: z.ZodType<
+  ToolsCallParameter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  value: z.string(),
+  items: z.array(z.lazy(() => ToolsCallParameter$inboundSchema)).optional(),
+  properties: z.record(z.lazy(() => ToolsCallParameter$inboundSchema))
+    .optional(),
+});
+
+/** @internal */
+export type ToolsCallParameter$Outbound = {
+  name: string;
+  value: string;
+  items?: Array<ToolsCallParameter$Outbound> | undefined;
+  properties?: { [k: string]: ToolsCallParameter$Outbound } | undefined;
+};
+
+/** @internal */
+export const ToolsCallParameter$outboundSchema: z.ZodType<
+  ToolsCallParameter$Outbound,
+  z.ZodTypeDef,
+  ToolsCallParameter
+> = z.object({
+  name: z.string(),
+  value: z.string(),
+  items: z.array(z.lazy(() => ToolsCallParameter$outboundSchema)).optional(),
+  properties: z.record(z.lazy(() => ToolsCallParameter$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 ToolsCallParameter$ {
+  /** @deprecated use `ToolsCallParameter$inboundSchema` instead. */
+  export const inboundSchema = ToolsCallParameter$inboundSchema;
+  /** @deprecated use `ToolsCallParameter$outboundSchema` instead. */
+  export const outboundSchema = ToolsCallParameter$outboundSchema;
+  /** @deprecated use `ToolsCallParameter$Outbound` instead. */
+  export type Outbound = ToolsCallParameter$Outbound;
+}
+
+export function toolsCallParameterToJSON(
+  toolsCallParameter: ToolsCallParameter,
+): string {
+  return JSON.stringify(
+    ToolsCallParameter$outboundSchema.parse(toolsCallParameter),
+  );
+}
+
+export function toolsCallParameterFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolsCallParameter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolsCallParameter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolsCallParameter' from JSON`,
+  );
+}

package/src/models/components/toolscallrequest.ts

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ToolsCallParameter,
+  ToolsCallParameter$inboundSchema,
+  ToolsCallParameter$Outbound,
+  ToolsCallParameter$outboundSchema,
+} from "./toolscallparameter.js";
+
+export type ToolsCallRequest = {
+  /**
+   * Required name of the tool to execute
+   */
+  name: string;
+  /**
+   * The parameters for the tool. Each key is the name of the parameter and the value is the parameter object.
+   */
+  parameters: { [k: string]: ToolsCallParameter };
+};
+
+/** @internal */
+export const ToolsCallRequest$inboundSchema: z.ZodType<
+  ToolsCallRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  parameters: z.record(ToolsCallParameter$inboundSchema),
+});
+
+/** @internal */
+export type ToolsCallRequest$Outbound = {
+  name: string;
+  parameters: { [k: string]: ToolsCallParameter$Outbound };
+};
+
+/** @internal */
+export const ToolsCallRequest$outboundSchema: z.ZodType<
+  ToolsCallRequest$Outbound,
+  z.ZodTypeDef,
+  ToolsCallRequest
+> = z.object({
+  name: z.string(),
+  parameters: z.record(ToolsCallParameter$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolsCallRequest$ {
+  /** @deprecated use `ToolsCallRequest$inboundSchema` instead. */
+  export const inboundSchema = ToolsCallRequest$inboundSchema;
+  /** @deprecated use `ToolsCallRequest$outboundSchema` instead. */
+  export const outboundSchema = ToolsCallRequest$outboundSchema;
+  /** @deprecated use `ToolsCallRequest$Outbound` instead. */
+  export type Outbound = ToolsCallRequest$Outbound;
+}
+
+export function toolsCallRequestToJSON(
+  toolsCallRequest: ToolsCallRequest,
+): string {
+  return JSON.stringify(
+    ToolsCallRequest$outboundSchema.parse(toolsCallRequest),
+  );
+}
+
+export function toolsCallRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolsCallRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolsCallRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolsCallRequest' from JSON`,
+  );
+}

package/src/models/components/toolscallresponse.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ToolsCallResponse = {
+  /**
+   * The raw response from the tool
+   */
+  rawResponse?: { [k: string]: any } | undefined;
+  /**
+   * The error message if applicable
+   */
+  error?: string | undefined;
+};
+
+/** @internal */
+export const ToolsCallResponse$inboundSchema: z.ZodType<
+  ToolsCallResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  rawResponse: z.record(z.any()).optional(),
+  error: z.string().optional(),
+});
+
+/** @internal */
+export type ToolsCallResponse$Outbound = {
+  rawResponse?: { [k: string]: any } | undefined;
+  error?: string | undefined;
+};
+
+/** @internal */
+export const ToolsCallResponse$outboundSchema: z.ZodType<
+  ToolsCallResponse$Outbound,
+  z.ZodTypeDef,
+  ToolsCallResponse
+> = z.object({
+  rawResponse: z.record(z.any()).optional(),
+  error: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolsCallResponse$ {
+  /** @deprecated use `ToolsCallResponse$inboundSchema` instead. */
+  export const inboundSchema = ToolsCallResponse$inboundSchema;
+  /** @deprecated use `ToolsCallResponse$outboundSchema` instead. */
+  export const outboundSchema = ToolsCallResponse$outboundSchema;
+  /** @deprecated use `ToolsCallResponse$Outbound` instead. */
+  export type Outbound = ToolsCallResponse$Outbound;
+}
+
+export function toolsCallResponseToJSON(
+  toolsCallResponse: ToolsCallResponse,
+): string {
+  return JSON.stringify(
+    ToolsCallResponse$outboundSchema.parse(toolsCallResponse),
+  );
+}
+
+export function toolsCallResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolsCallResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolsCallResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolsCallResponse' from JSON`,
+  );
+}

package/src/models/components/toolslistresponse.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Tool,
+  Tool$inboundSchema,
+  Tool$Outbound,
+  Tool$outboundSchema,
+} from "./tool.js";
+
+export type ToolsListResponse = {
+  tools?: Array<Tool> | undefined;
+};
+
+/** @internal */
+export const ToolsListResponse$inboundSchema: z.ZodType<
+  ToolsListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tools: z.array(Tool$inboundSchema).optional(),
+});
+
+/** @internal */
+export type ToolsListResponse$Outbound = {
+  tools?: Array<Tool$Outbound> | undefined;
+};
+
+/** @internal */
+export const ToolsListResponse$outboundSchema: z.ZodType<
+  ToolsListResponse$Outbound,
+  z.ZodTypeDef,
+  ToolsListResponse
+> = z.object({
+  tools: z.array(Tool$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 ToolsListResponse$ {
+  /** @deprecated use `ToolsListResponse$inboundSchema` instead. */
+  export const inboundSchema = ToolsListResponse$inboundSchema;
+  /** @deprecated use `ToolsListResponse$outboundSchema` instead. */
+  export const outboundSchema = ToolsListResponse$outboundSchema;
+  /** @deprecated use `ToolsListResponse$Outbound` instead. */
+  export type Outbound = ToolsListResponse$Outbound;
+}
+
+export function toolsListResponseToJSON(
+  toolsListResponse: ToolsListResponse,
+): string {
+  return JSON.stringify(
+    ToolsListResponse$outboundSchema.parse(toolsListResponse),
+  );
+}
+
+export function toolsListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolsListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolsListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolsListResponse' from JSON`,
+  );
+}

package/src/models/operations/getrestapiv1toolslist.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetRestApiV1ToolsListRequest = {
+  /**
+   * Optional array of tool names to filter by
+   */
+  toolNames?: Array<string> | undefined;
+};
+
+/** @internal */
+export const GetRestApiV1ToolsListRequest$inboundSchema: z.ZodType<
+  GetRestApiV1ToolsListRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  toolNames: z.array(z.string()).optional(),
+});
+
+/** @internal */
+export type GetRestApiV1ToolsListRequest$Outbound = {
+  toolNames?: Array<string> | undefined;
+};
+
+/** @internal */
+export const GetRestApiV1ToolsListRequest$outboundSchema: z.ZodType<
+  GetRestApiV1ToolsListRequest$Outbound,
+  z.ZodTypeDef,
+  GetRestApiV1ToolsListRequest
+> = z.object({
+  toolNames: z.array(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetRestApiV1ToolsListRequest$ {
+  /** @deprecated use `GetRestApiV1ToolsListRequest$inboundSchema` instead. */
+  export const inboundSchema = GetRestApiV1ToolsListRequest$inboundSchema;
+  /** @deprecated use `GetRestApiV1ToolsListRequest$outboundSchema` instead. */
+  export const outboundSchema = GetRestApiV1ToolsListRequest$outboundSchema;
+  /** @deprecated use `GetRestApiV1ToolsListRequest$Outbound` instead. */
+  export type Outbound = GetRestApiV1ToolsListRequest$Outbound;
+}
+
+export function getRestApiV1ToolsListRequestToJSON(
+  getRestApiV1ToolsListRequest: GetRestApiV1ToolsListRequest,
+): string {
+  return JSON.stringify(
+    GetRestApiV1ToolsListRequest$outboundSchema.parse(
+      getRestApiV1ToolsListRequest,
+    ),
+  );
+}
+
+export function getRestApiV1ToolsListRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetRestApiV1ToolsListRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetRestApiV1ToolsListRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetRestApiV1ToolsListRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -16,11 +16,12 @@ export * from "./getchat.js";
 export * from "./getchatapplication.js";
 export * from "./getchatfiles.js";
 export * from "./getdocvisibility.js";
-export * from "./getpolicies.js";
 export * from "./getpolicy.js";
 export * from "./getreportstatus.js";
+export * from "./getrestapiv1toolslist.js";
 export * from "./listchats.js";
 export * from "./listpins.js";
+export * from "./listpolicies.js";
 export * from "./listverifications.js";
 export * from "./postapiindexv1debugdatasourcedocument.js";
 export * from "./postapiindexv1debugdatasourcedocuments.js";

package/src/models/operations/{getpolicies.ts → listpolicies.ts}

@@ -7,7 +7,7 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type GetpoliciesRequest = {
+export type ListpoliciesRequest = {
   /**
    * Filter to return reports with a given value of auto-hide.
    */
@@ -19,8 +19,8 @@ export type GetpoliciesRequest = {
 };
 
 /** @internal */
-export const GetpoliciesRequest$inboundSchema: z.ZodType<
-  GetpoliciesRequest,
+export const ListpoliciesRequest$inboundSchema: z.ZodType<
+  ListpoliciesRequest,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -29,16 +29,16 @@ export const GetpoliciesRequest$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type GetpoliciesRequest$Outbound = {
+export type ListpoliciesRequest$Outbound = {
   autoHide?: boolean | undefined;
   frequency?: string | undefined;
 };
 
 /** @internal */
-export const GetpoliciesRequest$outboundSchema: z.ZodType<
-  GetpoliciesRequest$Outbound,
+export const ListpoliciesRequest$outboundSchema: z.ZodType<
+  ListpoliciesRequest$Outbound,
   z.ZodTypeDef,
-  GetpoliciesRequest
+  ListpoliciesRequest
 > = z.object({
   autoHide: z.boolean().optional(),
   frequency: z.string().optional(),
@@ -48,29 +48,29 @@ export const GetpoliciesRequest$outboundSchema: z.ZodType<
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace GetpoliciesRequest$ {
-  /** @deprecated use `GetpoliciesRequest$inboundSchema` instead. */
-  export const inboundSchema = GetpoliciesRequest$inboundSchema;
-  /** @deprecated use `GetpoliciesRequest$outboundSchema` instead. */
-  export const outboundSchema = GetpoliciesRequest$outboundSchema;
-  /** @deprecated use `GetpoliciesRequest$Outbound` instead. */
-  export type Outbound = GetpoliciesRequest$Outbound;
+export namespace ListpoliciesRequest$ {
+  /** @deprecated use `ListpoliciesRequest$inboundSchema` instead. */
+  export const inboundSchema = ListpoliciesRequest$inboundSchema;
+  /** @deprecated use `ListpoliciesRequest$outboundSchema` instead. */
+  export const outboundSchema = ListpoliciesRequest$outboundSchema;
+  /** @deprecated use `ListpoliciesRequest$Outbound` instead. */
+  export type Outbound = ListpoliciesRequest$Outbound;
 }
 
-export function getpoliciesRequestToJSON(
-  getpoliciesRequest: GetpoliciesRequest,
+export function listpoliciesRequestToJSON(
+  listpoliciesRequest: ListpoliciesRequest,
 ): string {
   return JSON.stringify(
-    GetpoliciesRequest$outboundSchema.parse(getpoliciesRequest),
+    ListpoliciesRequest$outboundSchema.parse(listpoliciesRequest),
   );
 }
 
-export function getpoliciesRequestFromJSON(
+export function listpoliciesRequestFromJSON(
   jsonString: string,
-): SafeParseResult<GetpoliciesRequest, SDKValidationError> {
+): SafeParseResult<ListpoliciesRequest, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => GetpoliciesRequest$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'GetpoliciesRequest' from JSON`,
+    (x) => ListpoliciesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListpoliciesRequest' from JSON`,
   );
 }

package/src/react-query/clientSearchQuery.ts

@@ -17,7 +17,7 @@ import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type ClientSearchQueryMutationVariables = {
-  request?: components.SearchRequest | undefined;
+  request: components.SearchRequest;
   options?: RequestOptions;
 };
 

package/src/react-query/clientSearchQueryAsAdmin.ts

@@ -17,7 +17,7 @@ import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type ClientSearchQueryAsAdminMutationVariables = {
-  request?: components.SearchRequest | undefined;
+  request: components.SearchRequest;
   options?: RequestOptions;
 };
 

package/src/react-query/clientSearchRecommendations.ts

@@ -17,7 +17,7 @@ import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type ClientSearchRecommendationsMutationVariables = {
-  request?: components.RecommendationsRequest | undefined;
+  request: components.RecommendationsRequest;
   options?: RequestOptions;
 };
 

package/src/react-query/clientToolsList.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { clientToolsList } from "../funcs/clientToolsList.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";
+import { useGleanContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type ClientToolsListQueryData = components.ToolsListResponse;
+
+/**
+ * List available tools
+ *
+ * @remarks
+ * Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned.
+ */
+export function useClientToolsList(
+  toolNames?: Array<string> | undefined,
+  options?: QueryHookOptions<ClientToolsListQueryData>,
+): UseQueryResult<ClientToolsListQueryData, Error> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildClientToolsListQuery(
+      client,
+      toolNames,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List available tools
+ *
+ * @remarks
+ * Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned.
+ */
+export function useClientToolsListSuspense(
+  toolNames?: Array<string> | undefined,
+  options?: SuspenseQueryHookOptions<ClientToolsListQueryData>,
+): UseSuspenseQueryResult<ClientToolsListQueryData, Error> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildClientToolsListQuery(
+      client,
+      toolNames,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchClientToolsList(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  toolNames?: Array<string> | undefined,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildClientToolsListQuery(
+      client$,
+      toolNames,
+    ),
+  });
+}
+
+export function setClientToolsListData(
+  client: QueryClient,
+  queryKeyBase: [parameters: { toolNames?: Array<string> | undefined }],
+  data: ClientToolsListQueryData,
+): ClientToolsListQueryData | undefined {
+  const key = queryKeyClientToolsList(...queryKeyBase);
+
+  return client.setQueryData<ClientToolsListQueryData>(key, data);
+}
+
+export function invalidateClientToolsList(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: { toolNames?: Array<string> | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "tools", "list", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllClientToolsList(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "tools", "list"],
+  });
+}
+
+export function buildClientToolsListQuery(
+  client$: GleanCore,
+  toolNames?: Array<string> | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (context: QueryFunctionContext) => Promise<ClientToolsListQueryData>;
+} {
+  return {
+    queryKey: queryKeyClientToolsList({ toolNames }),
+    queryFn: async function clientToolsListQueryFn(
+      ctx,
+    ): Promise<ClientToolsListQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(clientToolsList(
+        client$,
+        toolNames,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyClientToolsList(
+  parameters: { toolNames?: Array<string> | undefined },
+): QueryKey {
+  return ["@gleanwork/api-client", "tools", "list", parameters];
+}