@gleanwork/api-client 0.14.19 → 0.16.0

package/src/react-query/toolsGetActionPackAuthStatus.ts

@@ -0,0 +1,145 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 651b3a2e8f61
+ */
+
+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 {
+  buildToolsGetActionPackAuthStatusQuery,
+  prefetchToolsGetActionPackAuthStatus,
+  queryKeyToolsGetActionPackAuthStatus,
+  ToolsGetActionPackAuthStatusQueryData,
+} from "./toolsGetActionPackAuthStatus.core.js";
+export {
+  buildToolsGetActionPackAuthStatusQuery,
+  prefetchToolsGetActionPackAuthStatus,
+  queryKeyToolsGetActionPackAuthStatus,
+  type ToolsGetActionPackAuthStatusQueryData,
+};
+
+export type ToolsGetActionPackAuthStatusQueryError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get end-user authentication status for an action pack.
+ *
+ * @remarks
+ * Reports whether the calling user is already authenticated against the third-party
+ * tool backing the specified action pack. Intended for headless / server-driven clients
+ * that render an "Authorize" prompt when the user has not yet consented to the tool.
+ */
+export function useToolsGetActionPackAuthStatus(
+  actionPackId: string,
+  options?: QueryHookOptions<
+    ToolsGetActionPackAuthStatusQueryData,
+    ToolsGetActionPackAuthStatusQueryError
+  >,
+): UseQueryResult<
+  ToolsGetActionPackAuthStatusQueryData,
+  ToolsGetActionPackAuthStatusQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildToolsGetActionPackAuthStatusQuery(
+      client,
+      actionPackId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get end-user authentication status for an action pack.
+ *
+ * @remarks
+ * Reports whether the calling user is already authenticated against the third-party
+ * tool backing the specified action pack. Intended for headless / server-driven clients
+ * that render an "Authorize" prompt when the user has not yet consented to the tool.
+ */
+export function useToolsGetActionPackAuthStatusSuspense(
+  actionPackId: string,
+  options?: SuspenseQueryHookOptions<
+    ToolsGetActionPackAuthStatusQueryData,
+    ToolsGetActionPackAuthStatusQueryError
+  >,
+): UseSuspenseQueryResult<
+  ToolsGetActionPackAuthStatusQueryData,
+  ToolsGetActionPackAuthStatusQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildToolsGetActionPackAuthStatusQuery(
+      client,
+      actionPackId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setToolsGetActionPackAuthStatusData(
+  client: QueryClient,
+  queryKeyBase: [actionPackId: string],
+  data: ToolsGetActionPackAuthStatusQueryData,
+): ToolsGetActionPackAuthStatusQueryData | undefined {
+  const key = queryKeyToolsGetActionPackAuthStatus(...queryKeyBase);
+
+  return client.setQueryData<ToolsGetActionPackAuthStatusQueryData>(key, data);
+}
+
+export function invalidateToolsGetActionPackAuthStatus(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[actionPackId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "Tools",
+      "getActionPackAuthStatus",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllToolsGetActionPackAuthStatus(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "Tools", "getActionPackAuthStatus"],
+  });
+}

package/src/react-query/troubleshootingPostApiIndexV1DebugDatasourceDocumentEvents.ts

@@ -0,0 +1,132 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 25aad4d97aeb
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { troubleshootingPostApiIndexV1DebugDatasourceDocumentEvents } from "../funcs/troubleshootingPostApiIndexV1DebugDatasourceDocumentEvents.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 TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationVariables =
+  {
+    debugDocumentLifecycleRequest: components.DebugDocumentLifecycleRequest;
+    datasource: string;
+    options?: RequestOptions;
+  };
+
+export type TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationData =
+  components.DebugDocumentLifecycleResponse;
+
+export type TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Beta: Get document lifecycle events
+ *
+ * @remarks
+ * Retrieves lifecycle events for a specific document including upload time, index times and deletions. Rate limited to 1 request per minute per datasource. Currently in beta, might undergo breaking changes without prior notice.
+ */
+export function useTroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutation(
+  options?: MutationHookOptions<
+    TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationData,
+    TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationError,
+    TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationVariables
+  >,
+): UseMutationResult<
+  TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationData,
+  TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationError,
+  TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildTroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutation(
+      client,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function mutationKeyTroubleshootingPostApiIndexV1DebugDatasourceDocumentEvents(): MutationKey {
+  return [
+    "@gleanwork/api-client",
+    "Troubleshooting",
+    "postApiIndexV1DebugDatasourceDocumentEvents",
+  ];
+}
+
+export function buildTroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables:
+      TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationVariables,
+  ) => Promise<
+    TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationData
+  >;
+} {
+  return {
+    mutationKey:
+      mutationKeyTroubleshootingPostApiIndexV1DebugDatasourceDocumentEvents(),
+    mutationFn:
+      function troubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationFn(
+        {
+          debugDocumentLifecycleRequest,
+          datasource,
+          options,
+        },
+      ): Promise<
+        TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationData
+      > {
+        const mergedOptions = {
+          ...hookOptions,
+          ...options,
+          fetchOptions: {
+            ...hookOptions?.fetchOptions,
+            ...options?.fetchOptions,
+            signal: combineSignals(
+              hookOptions?.fetchOptions?.signal,
+              options?.fetchOptions?.signal,
+            ),
+          },
+        };
+        return unwrapAsync(
+          troubleshootingPostApiIndexV1DebugDatasourceDocumentEvents(
+            client$,
+            debugDocumentLifecycleRequest,
+            datasource,
+            mergedOptions,
+          ),
+        );
+      },
+  };
+}

package/src/sdk/agents.ts

@@ -3,31 +3,28 @@
  * @generated-id: a103cd018c9b
  */
 
-import { clientAgentsList } from "../funcs/clientAgentsList.js";
-import { clientAgentsRetrieve } from "../funcs/clientAgentsRetrieve.js";
-import { clientAgentsRetrieveSchemas } from "../funcs/clientAgentsRetrieveSchemas.js";
-import { clientAgentsRun } from "../funcs/clientAgentsRun.js";
-import { clientAgentsRunStream } from "../funcs/clientAgentsRunStream.js";
+import { agentsCreateAgent } from "../funcs/agentsCreateAgent.js";
+import { agentsEditAgent } from "../funcs/agentsEditAgent.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Agents extends ClientSDK {
   /**
-   * Retrieve an agent
+   * Create an agent
    *
    * @remarks
-   * Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder.
+   * Create an agent.
    */
-  async retrieve(
-    agentId: string,
+  async createAgent(
+    createWorkflowRequest: components.CreateWorkflowRequest,
     locale?: string | undefined,
     timezoneOffset?: number | undefined,
     options?: RequestOptions,
-  ): Promise<components.Agent> {
-    return unwrapAsync(clientAgentsRetrieve(
+  ): Promise<components.WorkflowResult> {
+    return unwrapAsync(agentsCreateAgent(
       this,
-      agentId,
+      createWorkflowRequest,
       locale,
       timezoneOffset,
       options,
@@ -35,74 +32,25 @@ export class Agents extends ClientSDK {
   }
 
   /**
-   * List an agent's schemas
+   * Edit an agent
    *
    * @remarks
-   * Return [agent](https://developers.glean.com/agents/agents-api)'s input and output schemas. You can use these schemas to detect changes to an agent's input or output structure.
+   * Creates a draft or publishes an [agent](https://developers.glean.com/agents/agents-api). Use `isDraft=true` to save a draft, or `isDraft=false` (or omit) to publish immediately. Only draft and publish modes are supported.
    */
-  async retrieveSchemas(
+  async editAgent(
+    editWorkflowRequest: components.EditWorkflowRequest,
     agentId: string,
     locale?: string | undefined,
     timezoneOffset?: number | undefined,
     options?: RequestOptions,
-  ): Promise<components.AgentSchemas> {
-    return unwrapAsync(clientAgentsRetrieveSchemas(
+  ): Promise<void> {
+    return unwrapAsync(agentsEditAgent(
       this,
+      editWorkflowRequest,
       agentId,
       locale,
       timezoneOffset,
       options,
     ));
   }
-
-  /**
-   * Search agents
-   *
-   * @remarks
-   * Search for [agents](https://developers.glean.com/agents/agents-api) by agent name.
-   */
-  async list(
-    request: components.SearchAgentsRequest,
-    options?: RequestOptions,
-  ): Promise<components.SearchAgentsResponse> {
-    return unwrapAsync(clientAgentsList(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Create an agent run and stream the response
-   *
-   * @remarks
-   * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE). **Note**: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the `input` object.
-   */
-  async runStream(
-    request: components.AgentRunCreate,
-    options?: RequestOptions,
-  ): Promise<string> {
-    return unwrapAsync(clientAgentsRunStream(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Create an agent run and wait for the response
-   *
-   * @remarks
-   * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response. **Note**: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the `input` object.
-   */
-  async run(
-    request: components.AgentRunCreate,
-    options?: RequestOptions,
-  ): Promise<components.AgentRunWaitResponse> {
-    return unwrapAsync(clientAgentsRun(
-      this,
-      request,
-      options,
-    ));
-  }
 }

package/src/sdk/chat.ts

@@ -3,221 +3,26 @@
  * @generated-id: c56babc22a20
  */
 
-import { clientChatCreate } from "../funcs/clientChatCreate.js";
-import { clientChatCreateStream } from "../funcs/clientChatCreateStream.js";
-import { clientChatDelete } from "../funcs/clientChatDelete.js";
-import { clientChatDeleteAll } from "../funcs/clientChatDeleteAll.js";
-import { clientChatDeleteFiles } from "../funcs/clientChatDeleteFiles.js";
-import { clientChatList } from "../funcs/clientChatList.js";
-import { clientChatRetrieve } from "../funcs/clientChatRetrieve.js";
-import { clientChatRetrieveApplication } from "../funcs/clientChatRetrieveApplication.js";
-import { clientChatRetrieveFiles } from "../funcs/clientChatRetrieveFiles.js";
-import { clientChatUploadFiles } from "../funcs/clientChatUploadFiles.js";
+import { chatGetChatFile } from "../funcs/chatGetChatFile.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as components from "../models/components/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Chat extends ClientSDK {
   /**
-   * Chat
+   * Download a chat file
    *
    * @remarks
-   * Have a conversation with Glean AI.
+   * Download the raw content of a file generated or uploaded during a chat session (for example, an image produced by the assistant). Returns the file bytes with a Content-Type header matching the file's MIME type.
    */
-  async create(
-    chatRequest: components.ChatRequest,
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
+  async getChatFile(
+    fileId: string,
+    preview?: boolean | undefined,
     options?: RequestOptions,
-  ): Promise<components.ChatResponse> {
-    return unwrapAsync(clientChatCreate(
+  ): Promise<ReadableStream<Uint8Array>> {
+    return unwrapAsync(chatGetChatFile(
       this,
-      chatRequest,
-      locale,
-      timezoneOffset,
-      options,
-    ));
-  }
-
-  /**
-   * Deletes all saved Chats owned by a user
-   *
-   * @remarks
-   * Deletes all saved Chats a user has had and all their contained conversational content.
-   */
-  async deleteAll(
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
-    options?: RequestOptions,
-  ): Promise<void> {
-    return unwrapAsync(clientChatDeleteAll(
-      this,
-      locale,
-      timezoneOffset,
-      options,
-    ));
-  }
-
-  /**
-   * Deletes saved Chats
-   *
-   * @remarks
-   * Deletes saved Chats and all their contained conversational content.
-   */
-  async delete(
-    deleteChatsRequest: components.DeleteChatsRequest,
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
-    options?: RequestOptions,
-  ): Promise<void> {
-    return unwrapAsync(clientChatDelete(
-      this,
-      deleteChatsRequest,
-      locale,
-      timezoneOffset,
-      options,
-    ));
-  }
-
-  /**
-   * Retrieves a Chat
-   *
-   * @remarks
-   * Retrieves the chat history between Glean Assistant and the user for a given Chat.
-   */
-  async retrieve(
-    getChatRequest: components.GetChatRequest,
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
-    options?: RequestOptions,
-  ): Promise<components.GetChatResponse> {
-    return unwrapAsync(clientChatRetrieve(
-      this,
-      getChatRequest,
-      locale,
-      timezoneOffset,
-      options,
-    ));
-  }
-
-  /**
-   * Retrieves all saved Chats
-   *
-   * @remarks
-   * Retrieves all the saved Chats between Glean Assistant and the user. The returned Chats contain only metadata and no conversational content.
-   */
-  async list(
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
-    options?: RequestOptions,
-  ): Promise<components.ListChatsResponse> {
-    return unwrapAsync(clientChatList(
-      this,
-      locale,
-      timezoneOffset,
-      options,
-    ));
-  }
-
-  /**
-   * Gets the metadata for a custom Chat application
-   *
-   * @remarks
-   * Gets the Chat application details for the specified application ID.
-   */
-  async retrieveApplication(
-    getChatApplicationRequest: components.GetChatApplicationRequest,
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
-    options?: RequestOptions,
-  ): Promise<components.GetChatApplicationResponse> {
-    return unwrapAsync(clientChatRetrieveApplication(
-      this,
-      getChatApplicationRequest,
-      locale,
-      timezoneOffset,
-      options,
-    ));
-  }
-
-  /**
-   * Upload files for Chat
-   *
-   * @remarks
-   * Upload files for Chat.
-   */
-  async uploadFiles(
-    uploadChatFilesRequest: components.UploadChatFilesRequest,
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
-    options?: RequestOptions,
-  ): Promise<components.UploadChatFilesResponse> {
-    return unwrapAsync(clientChatUploadFiles(
-      this,
-      uploadChatFilesRequest,
-      locale,
-      timezoneOffset,
-      options,
-    ));
-  }
-
-  /**
-   * Get files uploaded by a user for Chat
-   *
-   * @remarks
-   * Get files uploaded by a user for Chat.
-   */
-  async retrieveFiles(
-    getChatFilesRequest: components.GetChatFilesRequest,
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
-    options?: RequestOptions,
-  ): Promise<components.GetChatFilesResponse> {
-    return unwrapAsync(clientChatRetrieveFiles(
-      this,
-      getChatFilesRequest,
-      locale,
-      timezoneOffset,
-      options,
-    ));
-  }
-
-  /**
-   * Delete files uploaded by a user for chat
-   *
-   * @remarks
-   * Delete files uploaded by a user for Chat.
-   */
-  async deleteFiles(
-    deleteChatFilesRequest: components.DeleteChatFilesRequest,
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
-    options?: RequestOptions,
-  ): Promise<void> {
-    return unwrapAsync(clientChatDeleteFiles(
-      this,
-      deleteChatFilesRequest,
-      locale,
-      timezoneOffset,
-      options,
-    ));
-  }
-
-  /**
-   * Chat
-   *
-   * @remarks
-   * Have a conversation with Glean AI.
-   */
-  async createStream(
-    chatRequest: components.ChatRequest,
-    timezoneOffset?: number | undefined,
-    options?: RequestOptions,
-  ): Promise<string> {
-    return unwrapAsync(clientChatCreateStream(
-      this,
-      chatRequest,
-      timezoneOffset,
+      fileId,
+      preview,
       options,
     ));
   }

package/src/sdk/client.ts

@@ -5,21 +5,21 @@
 
 import { ClientSDK } from "../lib/sdks.js";
 import { Activity } from "./activity.js";
-import { Agents } from "./agents.js";
 import { Announcements } from "./announcements.js";
 import { Answers } from "./answers.js";
-import { Chat } from "./chat.js";
+import { ClientAgents } from "./clientagents.js";
 import { ClientAuthentication } from "./clientauthentication.js";
+import { ClientChat } from "./clientchat.js";
 import { ClientDocuments } from "./clientdocuments.js";
+import { ClientEntities } from "./cliententities.js";
 import { ClientGovernance } from "./clientgovernance.js";
 import { ClientShortcuts } from "./clientshortcuts.js";
+import { ClientTools } from "./clienttools.js";
 import { Collections } from "./collections.js";
-import { Entities } from "./entities.js";
 import { Insights } from "./insights.js";
 import { Messages } from "./messages.js";
 import { Pins } from "./pins.js";
 import { Search } from "./search.js";
-import { Tools } from "./tools.js";
 import { Verification } from "./verification.js";
 
 export class Client extends ClientSDK {
@@ -43,14 +43,14 @@ export class Client extends ClientSDK {
     return (this._authentication ??= new ClientAuthentication(this._options));
   }
 
-  private _chat?: Chat;
-  get chat(): Chat {
-    return (this._chat ??= new Chat(this._options));
+  private _chat?: ClientChat;
+  get chat(): ClientChat {
+    return (this._chat ??= new ClientChat(this._options));
   }
 
-  private _agents?: Agents;
-  get agents(): Agents {
-    return (this._agents ??= new Agents(this._options));
+  private _agents?: ClientAgents;
+  get agents(): ClientAgents {
+    return (this._agents ??= new ClientAgents(this._options));
   }
 
   private _collections?: Collections;
@@ -83,9 +83,9 @@ export class Client extends ClientSDK {
     return (this._search ??= new Search(this._options));
   }
 
-  private _entities?: Entities;
-  get entities(): Entities {
-    return (this._entities ??= new Entities(this._options));
+  private _entities?: ClientEntities;
+  get entities(): ClientEntities {
+    return (this._entities ??= new ClientEntities(this._options));
   }
 
   private _shortcuts?: ClientShortcuts;
@@ -98,9 +98,9 @@ export class Client extends ClientSDK {
     return (this._verification ??= new Verification(this._options));
   }
 
-  private _tools?: Tools;
-  get tools(): Tools {
-    return (this._tools ??= new Tools(this._options));
+  private _tools?: ClientTools;
+  get tools(): ClientTools {
+    return (this._tools ??= new ClientTools(this._options));
   }
 
   private _governance?: ClientGovernance;