@gleanwork/api-client 0.16.1 → 0.17.0

package/src/react-query/indexingDocumentsDebugEvents.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a35a22a5a14c
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingDocumentsDebugEvents } from "../funcs/indexingDocumentsDebugEvents.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 IndexingDocumentsDebugEventsMutationVariables = {
+  debugDocumentLifecycleRequest: components.DebugDocumentLifecycleRequest;
+  datasource: string;
+  options?: RequestOptions;
+};
+
+export type IndexingDocumentsDebugEventsMutationData =
+  components.DebugDocumentLifecycleResponse;
+
+export type IndexingDocumentsDebugEventsMutationError =
+  | 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 useIndexingDocumentsDebugEventsMutation(
+  options?: MutationHookOptions<
+    IndexingDocumentsDebugEventsMutationData,
+    IndexingDocumentsDebugEventsMutationError,
+    IndexingDocumentsDebugEventsMutationVariables
+  >,
+): UseMutationResult<
+  IndexingDocumentsDebugEventsMutationData,
+  IndexingDocumentsDebugEventsMutationError,
+  IndexingDocumentsDebugEventsMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingDocumentsDebugEventsMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingDocumentsDebugEvents(): MutationKey {
+  return ["@gleanwork/api-client", "documents", "debugEvents"];
+}
+
+export function buildIndexingDocumentsDebugEventsMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingDocumentsDebugEventsMutationVariables,
+  ) => Promise<IndexingDocumentsDebugEventsMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingDocumentsDebugEvents(),
+    mutationFn: function indexingDocumentsDebugEventsMutationFn({
+      debugDocumentLifecycleRequest,
+      datasource,
+      options,
+    }): Promise<IndexingDocumentsDebugEventsMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingDocumentsDebugEvents(
+        client$,
+        debugDocumentLifecycleRequest,
+        datasource,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/searchQuery.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a67629da8040
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { searchQuery } from "../funcs/searchQuery.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 { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type SearchQueryMutationVariables = {
+  request: components.PlatformSearchRequest;
+  options?: RequestOptions;
+};
+
+export type SearchQueryMutationData = components.PlatformSearchResponse;
+
+export type SearchQueryMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Search
+ *
+ * @remarks
+ * Execute a search query and retrieve ranked results. This is the data retrieval variant of the search API and returns only results and pagination state.
+ */
+export function useSearchQueryMutation(
+  options?: MutationHookOptions<
+    SearchQueryMutationData,
+    SearchQueryMutationError,
+    SearchQueryMutationVariables
+  >,
+): UseMutationResult<
+  SearchQueryMutationData,
+  SearchQueryMutationError,
+  SearchQueryMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildSearchQueryMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySearchQuery(): MutationKey {
+  return ["@gleanwork/api-client", "search", "query"];
+}
+
+export function buildSearchQueryMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SearchQueryMutationVariables,
+  ) => Promise<SearchQueryMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySearchQuery(),
+    mutationFn: function searchQueryMutationFn({
+      request,
+      options,
+    }): Promise<SearchQueryMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(searchQuery(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/sdk/agents.ts

@@ -3,53 +3,89 @@
  * @generated-id: a103cd018c9b
  */
 
-import { agentsCreateAgent } from "../funcs/agentsCreateAgent.js";
-import { agentsEditAgent } from "../funcs/agentsEditAgent.js";
+import {
+  agentsCreateRun,
+  CreateRunAcceptEnum,
+} from "../funcs/agentsCreateRun.js";
+import { agentsGet } from "../funcs/agentsGet.js";
+import { agentsGetSchemas } from "../funcs/agentsGetSchemas.js";
+import { agentsSearch } from "../funcs/agentsSearch.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
+export { CreateRunAcceptEnum } from "../funcs/agentsCreateRun.js";
+
 export class Agents extends ClientSDK {
   /**
-   * Create an agent
+   * Search agents
+   *
+   * @remarks
+   * Search agents available to the authenticated user by agent name.
+   */
+  async search(
+    request: components.PlatformAgentsSearchRequest,
+    options?: RequestOptions,
+  ): Promise<components.PlatformAgentsSearchResponse> {
+    return unwrapAsync(agentsSearch(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get agent
    *
    * @remarks
-   * Create an agent.
+   * Retrieve details for an agent available to the authenticated user.
    */
-  async createAgent(
-    createWorkflowRequest: components.CreateWorkflowRequest,
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
+  async get(
+    agentId: string,
     options?: RequestOptions,
-  ): Promise<components.WorkflowResult> {
-    return unwrapAsync(agentsCreateAgent(
+  ): Promise<components.PlatformAgentGetResponse> {
+    return unwrapAsync(agentsGet(
       this,
-      createWorkflowRequest,
-      locale,
-      timezoneOffset,
+      agentId,
       options,
     ));
   }
 
   /**
-   * Edit an agent
+   * Get agent schemas
    *
    * @remarks
-   * 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.
+   * Retrieve an agent's input and output JSON schemas.
    */
-  async editAgent(
-    editWorkflowRequest: components.EditWorkflowRequest,
+  async getSchemas(
     agentId: string,
-    locale?: string | undefined,
-    timezoneOffset?: number | undefined,
+    includeTools?: boolean | undefined,
     options?: RequestOptions,
-  ): Promise<void> {
-    return unwrapAsync(agentsEditAgent(
+  ): Promise<components.PlatformAgentSchemasResponse> {
+    return unwrapAsync(agentsGetSchemas(
+      this,
+      agentId,
+      includeTools,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async createRun(
+    platformAgentRunCreateRequest: components.PlatformAgentRunCreateRequest,
+    agentId: string,
+    options?: RequestOptions & { acceptHeaderOverride?: CreateRunAcceptEnum },
+  ): Promise<operations.PlatformAgentsCreateRunResponse> {
+    return unwrapAsync(agentsCreateRun(
       this,
-      editWorkflowRequest,
+      platformAgentRunCreateRequest,
       agentId,
-      locale,
-      timezoneOffset,
       options,
     ));
   }

package/src/sdk/chat.ts

@@ -3,27 +3,242 @@
  * @generated-id: c56babc22a20
  */
 
-import { chatGetChatFile } from "../funcs/chatGetChatFile.js";
+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 { clientChatRetrieveFile } from "../funcs/clientChatRetrieveFile.js";
+import { clientChatRetrieveFiles } from "../funcs/clientChatRetrieveFiles.js";
+import { clientChatUploadFiles } from "../funcs/clientChatUploadFiles.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
+   *
+   * @remarks
+   * Have a conversation with Glean AI.
+   */
+  async create(
+    chatRequest: components.ChatRequest,
+    locale?: string | undefined,
+    timezoneOffset?: number | undefined,
+    options?: RequestOptions,
+  ): Promise<components.ChatResponse> {
+    return unwrapAsync(clientChatCreate(
+      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,
+    ));
+  }
+
   /**
    * Download a chat file
    *
    * @remarks
    * 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 getChatFile(
+  async retrieveFile(
     fileId: string,
     preview?: boolean | undefined,
     options?: RequestOptions,
   ): Promise<ReadableStream<Uint8Array>> {
-    return unwrapAsync(chatGetChatFile(
+    return unwrapAsync(clientChatRetrieveFile(
       this,
       fileId,
       preview,
       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,
+      options,
+    ));
+  }
 }

package/src/sdk/client.ts

@@ -7,19 +7,20 @@ import { ClientSDK } from "../lib/sdks.js";
 import { Activity } from "./activity.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 { ClientDatasources } from "./clientdatasources.js";
 import { ClientDocuments } from "./clientdocuments.js";
-import { ClientEntities } from "./cliententities.js";
-import { ClientGovernance } from "./clientgovernance.js";
+import { ClientSearch } from "./clientsearch.js";
 import { ClientShortcuts } from "./clientshortcuts.js";
-import { ClientTools } from "./clienttools.js";
 import { Collections } from "./collections.js";
+import { Entities } from "./entities.js";
+import { Governance } from "./governance.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,9 +44,9 @@ export class Client extends ClientSDK {
     return (this._authentication ??= new ClientAuthentication(this._options));
   }
 
-  private _chat?: ClientChat;
-  get chat(): ClientChat {
-    return (this._chat ??= new ClientChat(this._options));
+  private _chat?: Chat;
+  get chat(): Chat {
+    return (this._chat ??= new Chat(this._options));
   }
 
   private _agents?: ClientAgents;
@@ -78,14 +79,14 @@ export class Client extends ClientSDK {
     return (this._pins ??= new Pins(this._options));
   }
 
-  private _search?: Search;
-  get search(): Search {
-    return (this._search ??= new Search(this._options));
+  private _search?: ClientSearch;
+  get search(): ClientSearch {
+    return (this._search ??= new ClientSearch(this._options));
   }
 
-  private _entities?: ClientEntities;
-  get entities(): ClientEntities {
-    return (this._entities ??= new ClientEntities(this._options));
+  private _entities?: Entities;
+  get entities(): Entities {
+    return (this._entities ??= new Entities(this._options));
   }
 
   private _shortcuts?: ClientShortcuts;
@@ -98,13 +99,18 @@ export class Client extends ClientSDK {
     return (this._verification ??= new Verification(this._options));
   }
 
-  private _tools?: ClientTools;
-  get tools(): ClientTools {
-    return (this._tools ??= new ClientTools(this._options));
+  private _tools?: Tools;
+  get tools(): Tools {
+    return (this._tools ??= new Tools(this._options));
   }
 
-  private _governance?: ClientGovernance;
-  get governance(): ClientGovernance {
-    return (this._governance ??= new ClientGovernance(this._options));
+  private _governance?: Governance;
+  get governance(): Governance {
+    return (this._governance ??= new Governance(this._options));
+  }
+
+  private _datasources?: ClientDatasources;
+  get datasources(): ClientDatasources {
+    return (this._datasources ??= new ClientDatasources(this._options));
   }
 }