@gleanwork/api-client 0.17.1 → 0.17.2

package/src/models/components/index.ts

@@ -40,6 +40,8 @@ export * from "./assistantinsightsresponse.js";
 export * from "./authconfig.js";
 export * from "./authorizeactionpackrequest.js";
 export * from "./authorizeactionpackresponse.js";
+export * from "./authorizetoolserverrequest.js";
+export * from "./authorizetoolserverresponse.js";
 export * from "./authstatus.js";
 export * from "./authtoken.js";
 export * from "./autocompleterequest.js";
@@ -450,6 +452,8 @@ export * from "./toolparameter.js";
 export * from "./toolscallparameter.js";
 export * from "./toolscallrequest.js";
 export * from "./toolscallresponse.js";
+export * from "./toolserverauthstatus.js";
+export * from "./toolserverauthstatusresponse.js";
 export * from "./toolsets.js";
 export * from "./toolslistresponse.js";
 export * from "./ugctype.js";

package/src/models/components/toolserverauthstatus.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 071ce1b5ce41
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Authentication status for the calling user.
+ */
+export const ToolServerAuthStatus = {
+  AwaitingAuth: "AWAITING_AUTH",
+  Authorized: "AUTHORIZED",
+} as const;
+/**
+ * Authentication status for the calling user.
+ */
+export type ToolServerAuthStatus = OpenEnum<typeof ToolServerAuthStatus>;
+
+/** @internal */
+export const ToolServerAuthStatus$inboundSchema: z.ZodType<
+  ToolServerAuthStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ToolServerAuthStatus);

package/src/models/components/toolserverauthstatusresponse.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9b8d34bb7e2d
+ */
+
+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 {
+  ActionAuthType,
+  ActionAuthType$inboundSchema,
+} from "./actionauthtype.js";
+import {
+  ToolServerAuthStatus,
+  ToolServerAuthStatus$inboundSchema,
+} from "./toolserverauthstatus.js";
+
+export type ToolServerAuthStatusResponse = {
+  /**
+   * Human-readable name of the tool server.
+   */
+  displayName?: string | undefined;
+  /**
+   * Logo URL for the tool server.
+   */
+  logoUrl?: string | undefined;
+  /**
+   * Brief description of the tool server.
+   */
+  description?: string | undefined;
+  /**
+   * Authentication status for the calling user.
+   */
+  authStatus: ToolServerAuthStatus;
+  /**
+   * Authentication mechanism used by an action pack.
+   *
+   * @remarks
+   *   - `AUTH_USER_OAUTH`: Requires per-user OAuth consent to the third-party tool.
+   *   - `AUTH_ADMIN`: Uses a service-account / admin-owned credential. End users do not authorize individually.
+   *   - `AUTH_NONE`: Action pack requires no authentication.
+   */
+  authType: ActionAuthType;
+};
+
+/** @internal */
+export const ToolServerAuthStatusResponse$inboundSchema: z.ZodType<
+  ToolServerAuthStatusResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  displayName: z.string().optional(),
+  logoUrl: z.string().optional(),
+  description: z.string().optional(),
+  authStatus: ToolServerAuthStatus$inboundSchema,
+  authType: ActionAuthType$inboundSchema,
+});
+
+export function toolServerAuthStatusResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolServerAuthStatusResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolServerAuthStatusResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolServerAuthStatusResponse' from JSON`,
+  );
+}

package/src/models/operations/authorizetoolserver.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d7057ee40a5b
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+export type AuthorizeToolServerRequest = {
+  /**
+   * Unique identifier of the tool server.
+   */
+  serverId: string;
+  authorizeToolServerRequest: components.AuthorizeToolServerRequest;
+};
+
+/** @internal */
+export type AuthorizeToolServerRequest$Outbound = {
+  serverId: string;
+  AuthorizeToolServerRequest: components.AuthorizeToolServerRequest$Outbound;
+};
+
+/** @internal */
+export const AuthorizeToolServerRequest$outboundSchema: z.ZodType<
+  AuthorizeToolServerRequest$Outbound,
+  z.ZodTypeDef,
+  AuthorizeToolServerRequest
+> = z.object({
+  serverId: z.string(),
+  authorizeToolServerRequest:
+    components.AuthorizeToolServerRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    authorizeToolServerRequest: "AuthorizeToolServerRequest",
+  });
+});
+
+export function authorizeToolServerRequestToJSON(
+  authorizeToolServerRequest: AuthorizeToolServerRequest,
+): string {
+  return JSON.stringify(
+    AuthorizeToolServerRequest$outboundSchema.parse(authorizeToolServerRequest),
+  );
+}

package/src/models/operations/gettoolserverauthstatus.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b9399d9292cf
+ */
+
+import * as z from "zod/v3";
+
+export type GetToolServerAuthStatusRequest = {
+  /**
+   * Unique identifier of the tool server.
+   */
+  serverId: string;
+};
+
+/** @internal */
+export type GetToolServerAuthStatusRequest$Outbound = {
+  serverId: string;
+};
+
+/** @internal */
+export const GetToolServerAuthStatusRequest$outboundSchema: z.ZodType<
+  GetToolServerAuthStatusRequest$Outbound,
+  z.ZodTypeDef,
+  GetToolServerAuthStatusRequest
+> = z.object({
+  serverId: z.string(),
+});
+
+export function getToolServerAuthStatusRequestToJSON(
+  getToolServerAuthStatusRequest: GetToolServerAuthStatusRequest,
+): string {
+  return JSON.stringify(
+    GetToolServerAuthStatusRequest$outboundSchema.parse(
+      getToolServerAuthStatusRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -7,6 +7,7 @@ export * from "./addcollectionitems.js";
 export * from "./addverificationreminder.js";
 export * from "./adminsearch.js";
 export * from "./authorizeactionpack.js";
+export * from "./authorizetoolserver.js";
 export * from "./autocomplete.js";
 export * from "./chat.js";
 export * from "./chatstream.js";
@@ -58,6 +59,7 @@ export * from "./getreportstatus.js";
 export * from "./getrestapiindexcustommetadataschemagroupname.js";
 export * from "./getrestapiv1toolslist.js";
 export * from "./getshortcut.js";
+export * from "./gettoolserverauthstatus.js";
 export * from "./insights.js";
 export * from "./listanswers.js";
 export * from "./listchats.js";

package/src/react-query/clientToolsAuthorizeToolServer.ts

@@ -0,0 +1,119 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 6ea6bcf043da
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { clientToolsAuthorizeToolServer } from "../funcs/clientToolsAuthorizeToolServer.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 { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type ClientToolsAuthorizeToolServerMutationVariables = {
+  authorizeToolServerRequest: components.AuthorizeToolServerRequest;
+  serverId: string;
+  options?: RequestOptions;
+};
+
+export type ClientToolsAuthorizeToolServerMutationData =
+  components.AuthorizeToolServerResponse;
+
+export type ClientToolsAuthorizeToolServerMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Start the OAuth authorization flow for a tool server.
+ *
+ * @remarks
+ * Initiates the third-party OAuth flow for the specified tool server and returns the
+ * authorization URL that the client should navigate the end user to. After the OAuth
+ * callback completes, the user's browser is redirected back to `returnUrl` with query
+ * parameters indicating the result.
+ *
+ * `returnUrl` must match the tenant's configured return URL allowlist; otherwise the
+ * request is rejected with 400.
+ */
+export function useClientToolsAuthorizeToolServerMutation(
+  options?: MutationHookOptions<
+    ClientToolsAuthorizeToolServerMutationData,
+    ClientToolsAuthorizeToolServerMutationError,
+    ClientToolsAuthorizeToolServerMutationVariables
+  >,
+): UseMutationResult<
+  ClientToolsAuthorizeToolServerMutationData,
+  ClientToolsAuthorizeToolServerMutationError,
+  ClientToolsAuthorizeToolServerMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildClientToolsAuthorizeToolServerMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyClientToolsAuthorizeToolServer(): MutationKey {
+  return ["@gleanwork/api-client", "tools", "authorizeToolServer"];
+}
+
+export function buildClientToolsAuthorizeToolServerMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: ClientToolsAuthorizeToolServerMutationVariables,
+  ) => Promise<ClientToolsAuthorizeToolServerMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyClientToolsAuthorizeToolServer(),
+    mutationFn: function clientToolsAuthorizeToolServerMutationFn({
+      authorizeToolServerRequest,
+      serverId,
+      options,
+    }): Promise<ClientToolsAuthorizeToolServerMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(clientToolsAuthorizeToolServer(
+        client$,
+        authorizeToolServerRequest,
+        serverId,
+        mergedOptions,
+      ));
+    },
+  };
+}

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

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 53a6c8e7c68e
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { clientToolsRetrieveToolServerAuthStatus } from "../funcs/clientToolsRetrieveToolServerAuthStatus.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 ClientToolsRetrieveToolServerAuthStatusQueryData =
+  components.ToolServerAuthStatusResponse;
+
+export function prefetchClientToolsRetrieveToolServerAuthStatus(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  serverId: string,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildClientToolsRetrieveToolServerAuthStatusQuery(
+      client$,
+      serverId,
+      options,
+    ),
+  });
+}
+
+export function buildClientToolsRetrieveToolServerAuthStatusQuery(
+  client$: GleanCore,
+  serverId: string,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<ClientToolsRetrieveToolServerAuthStatusQueryData>;
+} {
+  return {
+    queryKey: queryKeyClientToolsRetrieveToolServerAuthStatus(serverId),
+    queryFn: async function clientToolsRetrieveToolServerAuthStatusQueryFn(
+      ctx,
+    ): Promise<ClientToolsRetrieveToolServerAuthStatusQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(clientToolsRetrieveToolServerAuthStatus(
+        client$,
+        serverId,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyClientToolsRetrieveToolServerAuthStatus(
+  serverId: string,
+): QueryKey {
+  return [
+    "@gleanwork/api-client",
+    "tools",
+    "retrieveToolServerAuthStatus",
+    serverId,
+  ];
+}

package/src/react-query/clientToolsRetrieveToolServerAuthStatus.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 961b3d891d21
+ */
+
+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 { 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 {
+  buildClientToolsRetrieveToolServerAuthStatusQuery,
+  ClientToolsRetrieveToolServerAuthStatusQueryData,
+  prefetchClientToolsRetrieveToolServerAuthStatus,
+  queryKeyClientToolsRetrieveToolServerAuthStatus,
+} from "./clientToolsRetrieveToolServerAuthStatus.core.js";
+export {
+  buildClientToolsRetrieveToolServerAuthStatusQuery,
+  type ClientToolsRetrieveToolServerAuthStatusQueryData,
+  prefetchClientToolsRetrieveToolServerAuthStatus,
+  queryKeyClientToolsRetrieveToolServerAuthStatus,
+};
+
+export type ClientToolsRetrieveToolServerAuthStatusQueryError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get end-user authentication status for a tool server.
+ *
+ * @remarks
+ * Returns display information and the calling user's current authentication status
+ * for the specified tool server.
+ */
+export function useClientToolsRetrieveToolServerAuthStatus(
+  serverId: string,
+  options?: QueryHookOptions<
+    ClientToolsRetrieveToolServerAuthStatusQueryData,
+    ClientToolsRetrieveToolServerAuthStatusQueryError
+  >,
+): UseQueryResult<
+  ClientToolsRetrieveToolServerAuthStatusQueryData,
+  ClientToolsRetrieveToolServerAuthStatusQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildClientToolsRetrieveToolServerAuthStatusQuery(
+      client,
+      serverId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get end-user authentication status for a tool server.
+ *
+ * @remarks
+ * Returns display information and the calling user's current authentication status
+ * for the specified tool server.
+ */
+export function useClientToolsRetrieveToolServerAuthStatusSuspense(
+  serverId: string,
+  options?: SuspenseQueryHookOptions<
+    ClientToolsRetrieveToolServerAuthStatusQueryData,
+    ClientToolsRetrieveToolServerAuthStatusQueryError
+  >,
+): UseSuspenseQueryResult<
+  ClientToolsRetrieveToolServerAuthStatusQueryData,
+  ClientToolsRetrieveToolServerAuthStatusQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildClientToolsRetrieveToolServerAuthStatusQuery(
+      client,
+      serverId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setClientToolsRetrieveToolServerAuthStatusData(
+  client: QueryClient,
+  queryKeyBase: [serverId: string],
+  data: ClientToolsRetrieveToolServerAuthStatusQueryData,
+): ClientToolsRetrieveToolServerAuthStatusQueryData | undefined {
+  const key = queryKeyClientToolsRetrieveToolServerAuthStatus(...queryKeyBase);
+
+  return client.setQueryData<ClientToolsRetrieveToolServerAuthStatusQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateClientToolsRetrieveToolServerAuthStatus(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[serverId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "tools",
+      "retrieveToolServerAuthStatus",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllClientToolsRetrieveToolServerAuthStatus(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "tools",
+      "retrieveToolServerAuthStatus",
+    ],
+  });
+}

package/src/react-query/index.ts

@@ -91,8 +91,10 @@ export * from "./clientShortcutsList.js";
 export * from "./clientShortcutsRetrieve.js";
 export * from "./clientShortcutsUpdate.js";
 export * from "./clientToolsAuthorizeActionPack.js";
+export * from "./clientToolsAuthorizeToolServer.js";
 export * from "./clientToolsList.js";
 export * from "./clientToolsRetrieveActionPackAuthStatus.js";
+export * from "./clientToolsRetrieveToolServerAuthStatus.js";
 export * from "./clientToolsRun.js";
 export * from "./clientVerificationAddReminder.js";
 export * from "./clientVerificationList.js";

package/src/sdk/tools.ts

@@ -4,8 +4,10 @@
  */
 
 import { clientToolsAuthorizeActionPack } from "../funcs/clientToolsAuthorizeActionPack.js";
+import { clientToolsAuthorizeToolServer } from "../funcs/clientToolsAuthorizeToolServer.js";
 import { clientToolsList } from "../funcs/clientToolsList.js";
 import { clientToolsRetrieveActionPackAuthStatus } from "../funcs/clientToolsRetrieveActionPackAuthStatus.js";
+import { clientToolsRetrieveToolServerAuthStatus } from "../funcs/clientToolsRetrieveToolServerAuthStatus.js";
 import { clientToolsRun } from "../funcs/clientToolsRun.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -89,4 +91,47 @@ export class Tools extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Get end-user authentication status for a tool server.
+   *
+   * @remarks
+   * Returns display information and the calling user's current authentication status
+   * for the specified tool server.
+   */
+  async retrieveToolServerAuthStatus(
+    serverId: string,
+    options?: RequestOptions,
+  ): Promise<components.ToolServerAuthStatusResponse> {
+    return unwrapAsync(clientToolsRetrieveToolServerAuthStatus(
+      this,
+      serverId,
+      options,
+    ));
+  }
+
+  /**
+   * Start the OAuth authorization flow for a tool server.
+   *
+   * @remarks
+   * Initiates the third-party OAuth flow for the specified tool server and returns the
+   * authorization URL that the client should navigate the end user to. After the OAuth
+   * callback completes, the user's browser is redirected back to `returnUrl` with query
+   * parameters indicating the result.
+   *
+   * `returnUrl` must match the tenant's configured return URL allowlist; otherwise the
+   * request is rejected with 400.
+   */
+  async authorizeToolServer(
+    authorizeToolServerRequest: components.AuthorizeToolServerRequest,
+    serverId: string,
+    options?: RequestOptions,
+  ): Promise<components.AuthorizeToolServerResponse> {
+    return unwrapAsync(clientToolsAuthorizeToolServer(
+      this,
+      authorizeToolServerRequest,
+      serverId,
+      options,
+    ));
+  }
 }