@gleanwork/api-client 0.1.0-beta.1 → 0.1.0-beta.10

package/README.md

@@ -1,13 +1,56 @@
 # Glean TypeScript API Client
 
-<!-- No Summary [summary] -->
-
 The Glean TypeScript SDK provides convenient access to the Glean REST API in both browser and Node.js environments. It offers full TypeScript types, modern async/await support, and uses the [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) API under the hood.
 
+## Unified SDK Architecture
+
+This SDK combines both the Client and Indexing API namespaces into a single unified package:
+
+- **Client API**: Used for search, retrieval, and end-user interactions with Glean content
+- **Indexing API**: Used for indexing content, permissions, and other administrative operations
+
+Each namespace has its own authentication requirements and access patterns. While they serve different purposes, having them in a single SDK provides a consistent developer experience across all Glean API interactions.
+
+```typescript
+// Example of accessing Client namespace
+const glean = new Glean({ apiToken: "client-token" });
+await glean.client.search.query({ query: "search term" });
+
+// Example of accessing Indexing namespace 
+const glean = new Glean({ apiToken: "indexing-token" });
+await glean.indexing.documents.index({ /* document data */ });
+```
+
+Remember that each namespace requires its own authentication token type as described in the [Authentication Methods](#authentication-methods) section.
+
+<!-- Start Summary [summary] -->
+## Summary
+
+Glean API: # Introduction
+In addition to the data sources that Glean has built-in support for, Glean also provides a REST API that enables customers to put arbitrary content in the search index. This is useful, for example, for doing permissions-aware search over content in internal tools that reside on-prem as well as for searching over applications that Glean does not currently support first class. In addition these APIs allow the customer to push organization data (people info, organization structure etc) into Glean.
+
+# Usage guidelines
+This API is evolving fast. Glean will provide advance notice of any planned backwards incompatible changes along
+with a 6-month sunset period for anything that requires developers to adopt the new versions.
+
+# API Clients
+Official API clients for the Glean Indexing API are available in multiple languages:
+
+- [Python](https://github.com/gleanwork/api-client-python)
+- [TypeScript](https://github.com/gleanwork/api-client-typescript)
+- [Go](https://github.com/gleanwork/api-client-go)
+- [Java](https://github.com/gleanwork/api-client-java)
+
+These API clients provide type-safe, idiomatic interfaces for working with Glean IndexingAPIs in your language of choice.
+<!-- End Summary [summary] -->
+
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
 <!-- $toc-max-depth=2 -->
 * [Glean TypeScript API Client](#glean-typescript-api-client)
+  * [Unified SDK Architecture](#unified-sdk-architecture)
+* [Usage guidelines](#usage-guidelines)
+* [API Clients](#api-clients)
   * [SDK Installation](#sdk-installation)
   * [Requirements](#requirements)
   * [SDK Example Usage](#sdk-example-usage)
@@ -79,17 +122,47 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 <!-- Start SDK Example Usage [usage] -->
 ## SDK Example Usage
 
-### Example
+### Example 1
+
+```typescript
+import { Glean } from "@gleanwork/api-client";
+
+const glean = new Glean({
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await glean.client.chat.create({
+    messages: [
+      {
+        fragments: [
+          {
+            text: "What are the company holidays this year?",
+          },
+        ],
+      },
+    ],
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
+```
+
+### Example 2
 
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
-  const result = await glean.client.chat.start({
+  const result = await glean.client.chat.createStream({
     messages: [
       {
         fragments: [
@@ -117,16 +190,16 @@ run();
 
 This SDK supports the following security scheme globally:
 
-| Name         | Type | Scheme      | Environment Variable |
-| ------------ | ---- | ----------- | -------------------- |
-| `bearerAuth` | http | HTTP Bearer | `GLEAN_BEARER_AUTH`  |
+| Name       | Type | Scheme      | Environment Variable |
+| ---------- | ---- | ----------- | -------------------- |
+| `apiToken` | http | HTTP Bearer | `GLEAN_API_TOKEN`    |
 
-To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
+To authenticate with the API the `apiToken` parameter must be set when initializing the SDK client instance. For example:
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -163,28 +236,54 @@ run();
 ```
 <!-- End Authentication [security] -->
 
+### Authentication Methods
+
+Glean supports different authentication methods depending on which API namespace you're using:
+
+#### Client Namespace
+
+The Client namespace supports two authentication methods:
+
+1. **Manually Provisioned API Tokens**
+   - Can be created by an Admin or a user with the API Token Creator role
+   - Used for server-to-server integrations
+
+2. **OAuth**
+   - Requires OAuth setup to be completed by an Admin
+   - Used for user-based authentication flows
+
+#### Indexing Namespace
+
+The Indexing namespace supports only one authentication method:
+
+1. **Manually Provisioned API Tokens**
+   - Can be created by an Admin or a user with the API Token Creator role
+   - Used for secure document indexing operations
+
+> [!IMPORTANT]
+> Client tokens **will not work** for Indexing operations, and Indexing tokens **will not work** for Client operations. You must use the appropriate token type for the namespace you're accessing.
+
+For more information on obtaining the appropriate token type, please contact your Glean administrator.
+
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
 <details open>
 <summary>Available methods</summary>
 
-### [agents](docs/sdks/agents/README.md)
-
-* [runagent](docs/sdks/agents/README.md#runagent) - Runs an Agent.
-* [listagents](docs/sdks/agents/README.md#listagents) - Lists all agents.
-* [getagentinputs](docs/sdks/agents/README.md#getagentinputs) - Gets the inputs to an agent.
-
 ### [client](docs/sdks/client/README.md)
 
 
-#### [client.activities](docs/sdks/activities/README.md)
-
-* [reportActivity](docs/sdks/activities/README.md#reportactivity) - Report client activity
-
 #### [client.activity](docs/sdks/activity/README.md)
 
 * [report](docs/sdks/activity/README.md#report) - Report document activity
+* [feedback](docs/sdks/activity/README.md#feedback) - Report client activity
+
+#### [client.agents](docs/sdks/agents/README.md)
+
+* [run](docs/sdks/agents/README.md#run) - Runs an Agent.
+* [list](docs/sdks/agents/README.md#list) - Lists all agents.
+* [retrieveInputs](docs/sdks/agents/README.md#retrieveinputs) - Gets the inputs to an agent.
 
 #### [client.announcements](docs/sdks/announcements/README.md)
 
@@ -196,8 +295,8 @@ run();
 
 * [create](docs/sdks/answers/README.md#create) - Create Answer
 * [delete](docs/sdks/answers/README.md#delete) - Delete Answer
-* [edit](docs/sdks/answers/README.md#edit) - Update Answer
-* [get](docs/sdks/answers/README.md#get) - Read Answer
+* [update](docs/sdks/answers/README.md#update) - Update Answer
+* [retrieve](docs/sdks/answers/README.md#retrieve) - Read Answer
 * [list](docs/sdks/answers/README.md#list) - List Answers
 
 #### [client.authentication](docs/sdks/clientauthentication/README.md)
@@ -206,15 +305,16 @@ run();
 
 #### [client.chat](docs/sdks/chat/README.md)
 
-* [start](docs/sdks/chat/README.md#start) - Chat
+* [create](docs/sdks/chat/README.md#create) - Chat
 * [deleteAll](docs/sdks/chat/README.md#deleteall) - Deletes all saved Chats owned by a user
 * [delete](docs/sdks/chat/README.md#delete) - Deletes saved Chats
-* [get](docs/sdks/chat/README.md#get) - Retrieves a Chat
+* [retrieve](docs/sdks/chat/README.md#retrieve) - Retrieves a Chat
 * [list](docs/sdks/chat/README.md#list) - Retrieves all saved Chats
-* [getApplication](docs/sdks/chat/README.md#getapplication) - Gets the metadata for a custom Chat application
+* [retrieveApplication](docs/sdks/chat/README.md#retrieveapplication) - Gets the metadata for a custom Chat application
 * [uploadFiles](docs/sdks/chat/README.md#uploadfiles) - Upload files for Chat.
-* [getFiles](docs/sdks/chat/README.md#getfiles) - Get files uploaded by a user for Chat.
+* [retrieveFiles](docs/sdks/chat/README.md#retrievefiles) - Get files uploaded by a user for Chat.
 * [deleteFiles](docs/sdks/chat/README.md#deletefiles) - Delete files uploaded by a user for chat.
+* [createStream](docs/sdks/chat/README.md#createstream) - Chat
 
 #### [client.collections](docs/sdks/collections/README.md)
 
@@ -223,15 +323,16 @@ run();
 * [delete](docs/sdks/collections/README.md#delete) - Delete Collection
 * [deleteItem](docs/sdks/collections/README.md#deleteitem) - Delete Collection item
 * [update](docs/sdks/collections/README.md#update) - Update Collection
-* [editItem](docs/sdks/collections/README.md#edititem) - Update Collection item
-* [get](docs/sdks/collections/README.md#get) - Read Collection
+* [updateItem](docs/sdks/collections/README.md#updateitem) - Update Collection item
+* [retrieve](docs/sdks/collections/README.md#retrieve) - Read Collection
 * [list](docs/sdks/collections/README.md#list) - List Collections
 
 #### [client.documents](docs/sdks/clientdocuments/README.md)
 
-* [getPermissions](docs/sdks/clientdocuments/README.md#getpermissions) - Read document permissions
-* [get](docs/sdks/clientdocuments/README.md#get) - Read documents
-* [getByFacets](docs/sdks/clientdocuments/README.md#getbyfacets) - Read documents by facets
+* [retrievePermissions](docs/sdks/clientdocuments/README.md#retrievepermissions) - Read document permissions
+* [retrieve](docs/sdks/clientdocuments/README.md#retrieve) - Read documents
+* [retrieveByFacets](docs/sdks/clientdocuments/README.md#retrievebyfacets) - Read documents by facets
+* [summarize](docs/sdks/clientdocuments/README.md#summarize) - Summarize documents
 
 #### [client.entities](docs/sdks/entities/README.md)
 
@@ -240,40 +341,35 @@ run();
 
 #### [client.insights](docs/sdks/insights/README.md)
 
-* [get](docs/sdks/insights/README.md#get) - Read insights
+* [retrieve](docs/sdks/insights/README.md#retrieve) - Read insights
 
 #### [client.messages](docs/sdks/messages/README.md)
 
-* [get](docs/sdks/messages/README.md#get) - Read messages
+* [retrieve](docs/sdks/messages/README.md#retrieve) - Read messages
 
 #### [client.pins](docs/sdks/pins/README.md)
 
-* [edit](docs/sdks/pins/README.md#edit) - Update pin
-* [get](docs/sdks/pins/README.md#get) - Read pin
+* [update](docs/sdks/pins/README.md#update) - Update pin
+* [retrieve](docs/sdks/pins/README.md#retrieve) - Read pin
 * [list](docs/sdks/pins/README.md#list) - List pins
 * [create](docs/sdks/pins/README.md#create) - Create pin
 * [remove](docs/sdks/pins/README.md#remove) - Delete pin
 
 #### [client.search](docs/sdks/search/README.md)
 
-* [admin](docs/sdks/search/README.md#admin) - Search the index (admin)
+* [queryAsAdmin](docs/sdks/search/README.md#queryasadmin) - Search the index (admin)
 * [autocomplete](docs/sdks/search/README.md#autocomplete) - Autocomplete
-* [getFeed](docs/sdks/search/README.md#getfeed) - Feed of documents and events
+* [retrieveFeed](docs/sdks/search/README.md#retrievefeed) - Feed of documents and events
 * [recommendations](docs/sdks/search/README.md#recommendations) - Recommend documents
-* [execute](docs/sdks/search/README.md#execute) - Search
+* [query](docs/sdks/search/README.md#query) - Search
 
 #### [client.shortcuts](docs/sdks/clientshortcuts/README.md)
 
 * [create](docs/sdks/clientshortcuts/README.md#create) - Create shortcut
 * [delete](docs/sdks/clientshortcuts/README.md#delete) - Delete shortcut
-* [get](docs/sdks/clientshortcuts/README.md#get) - Read shortcut
+* [retrieve](docs/sdks/clientshortcuts/README.md#retrieve) - Read shortcut
 * [list](docs/sdks/clientshortcuts/README.md#list) - List shortcuts
 * [update](docs/sdks/clientshortcuts/README.md#update) - Update shortcut
-* [upload](docs/sdks/clientshortcuts/README.md#upload) - Upload shortcuts
-
-#### [client.summarize](docs/sdks/summarize/README.md)
-
-* [generate](docs/sdks/summarize/README.md#generate) - Summarize documents
 
 #### [client.verification](docs/sdks/verification/README.md)
 
@@ -289,10 +385,15 @@ run();
 
 * [rotateToken](docs/sdks/indexingauthentication/README.md#rotatetoken) - Rotate token
 
+#### [indexing.datasource](docs/sdks/datasource/README.md)
+
+* [status](docs/sdks/datasource/README.md#status) - Beta: Get datasource status
+
+
 #### [indexing.datasources](docs/sdks/datasources/README.md)
 
 * [add](docs/sdks/datasources/README.md#add) - Add or update datasource
-* [getConfig](docs/sdks/datasources/README.md#getconfig) - Get datasource config
+* [retrieveConfig](docs/sdks/datasources/README.md#retrieveconfig) - Get datasource config
 
 #### [indexing.documents](docs/sdks/indexingdocuments/README.md)
 
@@ -301,12 +402,21 @@ run();
 * [bulkIndex](docs/sdks/indexingdocuments/README.md#bulkindex) - Bulk index documents
 * [processAll](docs/sdks/indexingdocuments/README.md#processall) - Schedules the processing of uploaded documents
 * [delete](docs/sdks/indexingdocuments/README.md#delete) - Delete document
+* [debug](docs/sdks/indexingdocuments/README.md#debug) - Beta: Get document information
+
+* [debugMany](docs/sdks/indexingdocuments/README.md#debugmany) - Beta: Get information of a batch of documents
+
+* [checkAccess](docs/sdks/indexingdocuments/README.md#checkaccess) - Check document access
+* [~~status~~](docs/sdks/indexingdocuments/README.md#status) - Get document upload and indexing status :warning: **Deprecated**
+* [~~count~~](docs/sdks/indexingdocuments/README.md#count) - Get document count :warning: **Deprecated**
 
 #### [indexing.people](docs/sdks/people/README.md)
 
+* [debug](docs/sdks/people/README.md#debug) - Beta: Get user information
+
+* [~~count~~](docs/sdks/people/README.md#count) - Get user count :warning: **Deprecated**
 * [index](docs/sdks/people/README.md#index) - Index employee
-* [bulkIndexEmployees](docs/sdks/people/README.md#bulkindexemployees) - Bulk index employees
-* [~~bulkIndex~~](docs/sdks/people/README.md#bulkindex) - Bulk index employees :warning: **Deprecated**
+* [bulkIndex](docs/sdks/people/README.md#bulkindex) - Bulk index employees
 * [processAllEmployeesAndTeams](docs/sdks/people/README.md#processallemployeesandteams) - Schedules the processing of uploaded employees and teams
 * [delete](docs/sdks/people/README.md#delete) - Delete employee
 * [indexTeam](docs/sdks/people/README.md#indexteam) - Index team
@@ -331,21 +441,7 @@ run();
 #### [indexing.shortcuts](docs/sdks/indexingshortcuts/README.md)
 
 * [bulkIndex](docs/sdks/indexingshortcuts/README.md#bulkindex) - Bulk index external shortcuts
-
-#### [indexing.troubleshooting](docs/sdks/troubleshooting/README.md)
-
-* [getDatasourceStatus](docs/sdks/troubleshooting/README.md#getdatasourcestatus) - Beta: Get datasource status
-
-* [postDocumentDebug](docs/sdks/troubleshooting/README.md#postdocumentdebug) - Beta: Get document information
-
-* [postDocumentsDebug](docs/sdks/troubleshooting/README.md#postdocumentsdebug) - Beta: Get information of a batch of documents
-
-* [debugUser](docs/sdks/troubleshooting/README.md#debuguser) - Beta: Get user information
-
-* [checkAccess](docs/sdks/troubleshooting/README.md#checkaccess) - Check document access
-* [~~getStatus~~](docs/sdks/troubleshooting/README.md#getstatus) - Get document upload and indexing status :warning: **Deprecated**
-* [~~getDocumentCount~~](docs/sdks/troubleshooting/README.md#getdocumentcount) - Get document count :warning: **Deprecated**
-* [~~getUserCount~~](docs/sdks/troubleshooting/README.md#getusercount) - Get user count :warning: **Deprecated**
+* [upload](docs/sdks/indexingshortcuts/README.md#upload) - Upload shortcuts
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -365,74 +461,83 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [`agentsGetagentinputs`](docs/sdks/agents/README.md#getagentinputs) - Gets the inputs to an agent.
-- [`agentsListagents`](docs/sdks/agents/README.md#listagents) - Lists all agents.
-- [`agentsRunagent`](docs/sdks/agents/README.md#runagent) - Runs an Agent.
-- [`clientActivitiesReportActivity`](docs/sdks/activities/README.md#reportactivity) - Report client activity
+- [`clientActivityFeedback`](docs/sdks/activity/README.md#feedback) - Report client activity
 - [`clientActivityReport`](docs/sdks/activity/README.md#report) - Report document activity
+- [`clientAgentsList`](docs/sdks/agents/README.md#list) - Lists all agents.
+- [`clientAgentsRetrieveInputs`](docs/sdks/agents/README.md#retrieveinputs) - Gets the inputs to an agent.
+- [`clientAgentsRun`](docs/sdks/agents/README.md#run) - Runs an Agent.
 - [`clientAnnouncementsCreate`](docs/sdks/announcements/README.md#create) - Create Announcement
 - [`clientAnnouncementsDelete`](docs/sdks/announcements/README.md#delete) - Delete Announcement
 - [`clientAnnouncementsUpdate`](docs/sdks/announcements/README.md#update) - Update Announcement
 - [`clientAnswersCreate`](docs/sdks/answers/README.md#create) - Create Answer
 - [`clientAnswersDelete`](docs/sdks/answers/README.md#delete) - Delete Answer
-- [`clientAnswersEdit`](docs/sdks/answers/README.md#edit) - Update Answer
-- [`clientAnswersGet`](docs/sdks/answers/README.md#get) - Read Answer
 - [`clientAnswersList`](docs/sdks/answers/README.md#list) - List Answers
+- [`clientAnswersRetrieve`](docs/sdks/answers/README.md#retrieve) - Read Answer
+- [`clientAnswersUpdate`](docs/sdks/answers/README.md#update) - Update Answer
 - [`clientAuthenticationCreateToken`](docs/sdks/clientauthentication/README.md#createtoken) - Create authentication token
+- [`clientChatCreate`](docs/sdks/chat/README.md#create) - Chat
+- [`clientChatCreateStream`](docs/sdks/chat/README.md#createstream) - Chat
 - [`clientChatDelete`](docs/sdks/chat/README.md#delete) - Deletes saved Chats
 - [`clientChatDeleteAll`](docs/sdks/chat/README.md#deleteall) - Deletes all saved Chats owned by a user
 - [`clientChatDeleteFiles`](docs/sdks/chat/README.md#deletefiles) - Delete files uploaded by a user for chat.
-- [`clientChatGet`](docs/sdks/chat/README.md#get) - Retrieves a Chat
-- [`clientChatGetApplication`](docs/sdks/chat/README.md#getapplication) - Gets the metadata for a custom Chat application
-- [`clientChatGetFiles`](docs/sdks/chat/README.md#getfiles) - Get files uploaded by a user for Chat.
 - [`clientChatList`](docs/sdks/chat/README.md#list) - Retrieves all saved Chats
-- [`clientChatStart`](docs/sdks/chat/README.md#start) - Chat
+- [`clientChatRetrieve`](docs/sdks/chat/README.md#retrieve) - Retrieves a Chat
+- [`clientChatRetrieveApplication`](docs/sdks/chat/README.md#retrieveapplication) - Gets the metadata for a custom Chat application
+- [`clientChatRetrieveFiles`](docs/sdks/chat/README.md#retrievefiles) - Get files uploaded by a user for Chat.
 - [`clientChatUploadFiles`](docs/sdks/chat/README.md#uploadfiles) - Upload files for Chat.
 - [`clientCollectionsAddItems`](docs/sdks/collections/README.md#additems) - Add Collection item
 - [`clientCollectionsCreate`](docs/sdks/collections/README.md#create) - Create Collection
 - [`clientCollectionsDelete`](docs/sdks/collections/README.md#delete) - Delete Collection
 - [`clientCollectionsDeleteItem`](docs/sdks/collections/README.md#deleteitem) - Delete Collection item
-- [`clientCollectionsEditItem`](docs/sdks/collections/README.md#edititem) - Update Collection item
-- [`clientCollectionsGet`](docs/sdks/collections/README.md#get) - Read Collection
 - [`clientCollectionsList`](docs/sdks/collections/README.md#list) - List Collections
+- [`clientCollectionsRetrieve`](docs/sdks/collections/README.md#retrieve) - Read Collection
 - [`clientCollectionsUpdate`](docs/sdks/collections/README.md#update) - Update Collection
-- [`clientDocumentsGet`](docs/sdks/clientdocuments/README.md#get) - Read documents
-- [`clientDocumentsGetByFacets`](docs/sdks/clientdocuments/README.md#getbyfacets) - Read documents by facets
-- [`clientDocumentsGetPermissions`](docs/sdks/clientdocuments/README.md#getpermissions) - Read document permissions
+- [`clientCollectionsUpdateItem`](docs/sdks/collections/README.md#updateitem) - Update Collection item
+- [`clientDocumentsRetrieve`](docs/sdks/clientdocuments/README.md#retrieve) - Read documents
+- [`clientDocumentsRetrieveByFacets`](docs/sdks/clientdocuments/README.md#retrievebyfacets) - Read documents by facets
+- [`clientDocumentsRetrievePermissions`](docs/sdks/clientdocuments/README.md#retrievepermissions) - Read document permissions
+- [`clientDocumentsSummarize`](docs/sdks/clientdocuments/README.md#summarize) - Summarize documents
 - [`clientEntitiesList`](docs/sdks/entities/README.md#list) - List entities
 - [`clientEntitiesReadPeople`](docs/sdks/entities/README.md#readpeople) - Read people
-- [`clientInsightsGet`](docs/sdks/insights/README.md#get) - Read insights
-- [`clientMessagesGet`](docs/sdks/messages/README.md#get) - Read messages
+- [`clientInsightsRetrieve`](docs/sdks/insights/README.md#retrieve) - Read insights
+- [`clientMessagesRetrieve`](docs/sdks/messages/README.md#retrieve) - Read messages
 - [`clientPinsCreate`](docs/sdks/pins/README.md#create) - Create pin
-- [`clientPinsEdit`](docs/sdks/pins/README.md#edit) - Update pin
-- [`clientPinsGet`](docs/sdks/pins/README.md#get) - Read pin
 - [`clientPinsList`](docs/sdks/pins/README.md#list) - List pins
 - [`clientPinsRemove`](docs/sdks/pins/README.md#remove) - Delete pin
-- [`clientSearchAdmin`](docs/sdks/search/README.md#admin) - Search the index (admin)
+- [`clientPinsRetrieve`](docs/sdks/pins/README.md#retrieve) - Read pin
+- [`clientPinsUpdate`](docs/sdks/pins/README.md#update) - Update pin
 - [`clientSearchAutocomplete`](docs/sdks/search/README.md#autocomplete) - Autocomplete
-- [`clientSearchExecute`](docs/sdks/search/README.md#execute) - Search
-- [`clientSearchGetFeed`](docs/sdks/search/README.md#getfeed) - Feed of documents and events
+- [`clientSearchQuery`](docs/sdks/search/README.md#query) - Search
+- [`clientSearchQueryAsAdmin`](docs/sdks/search/README.md#queryasadmin) - Search the index (admin)
 - [`clientSearchRecommendations`](docs/sdks/search/README.md#recommendations) - Recommend documents
+- [`clientSearchRetrieveFeed`](docs/sdks/search/README.md#retrievefeed) - Feed of documents and events
 - [`clientShortcutsCreate`](docs/sdks/clientshortcuts/README.md#create) - Create shortcut
 - [`clientShortcutsDelete`](docs/sdks/clientshortcuts/README.md#delete) - Delete shortcut
-- [`clientShortcutsGet`](docs/sdks/clientshortcuts/README.md#get) - Read shortcut
 - [`clientShortcutsList`](docs/sdks/clientshortcuts/README.md#list) - List shortcuts
+- [`clientShortcutsRetrieve`](docs/sdks/clientshortcuts/README.md#retrieve) - Read shortcut
 - [`clientShortcutsUpdate`](docs/sdks/clientshortcuts/README.md#update) - Update shortcut
-- [`clientShortcutsUpload`](docs/sdks/clientshortcuts/README.md#upload) - Upload shortcuts
-- [`clientSummarizeGenerate`](docs/sdks/summarize/README.md#generate) - Summarize documents
 - [`clientVerificationAddReminder`](docs/sdks/verification/README.md#addreminder) - Create verification
 - [`clientVerificationList`](docs/sdks/verification/README.md#list) - List verifications
 - [`clientVerificationVerify`](docs/sdks/verification/README.md#verify) - Update verification
 - [`indexingAuthenticationRotateToken`](docs/sdks/indexingauthentication/README.md#rotatetoken) - Rotate token
 - [`indexingDatasourcesAdd`](docs/sdks/datasources/README.md#add) - Add or update datasource
-- [`indexingDatasourcesGetConfig`](docs/sdks/datasources/README.md#getconfig) - Get datasource config
+- [`indexingDatasourcesRetrieveConfig`](docs/sdks/datasources/README.md#retrieveconfig) - Get datasource config
+- [`indexingDatasourceStatus`](docs/sdks/datasource/README.md#status) - Beta: Get datasource status
+
 - [`indexingDocumentsAddOrUpdate`](docs/sdks/indexingdocuments/README.md#addorupdate) - Index document
 - [`indexingDocumentsBulkIndex`](docs/sdks/indexingdocuments/README.md#bulkindex) - Bulk index documents
+- [`indexingDocumentsCheckAccess`](docs/sdks/indexingdocuments/README.md#checkaccess) - Check document access
+- [`indexingDocumentsDebug`](docs/sdks/indexingdocuments/README.md#debug) - Beta: Get document information
+
+- [`indexingDocumentsDebugMany`](docs/sdks/indexingdocuments/README.md#debugmany) - Beta: Get information of a batch of documents
+
 - [`indexingDocumentsDelete`](docs/sdks/indexingdocuments/README.md#delete) - Delete document
 - [`indexingDocumentsIndex`](docs/sdks/indexingdocuments/README.md#index) - Index documents
 - [`indexingDocumentsProcessAll`](docs/sdks/indexingdocuments/README.md#processall) - Schedules the processing of uploaded documents
-- [`indexingPeopleBulkIndexEmployees`](docs/sdks/people/README.md#bulkindexemployees) - Bulk index employees
+- [`indexingPeopleBulkIndex`](docs/sdks/people/README.md#bulkindex) - Bulk index employees
 - [`indexingPeopleBulkIndexTeams`](docs/sdks/people/README.md#bulkindexteams) - Bulk index teams
+- [`indexingPeopleDebug`](docs/sdks/people/README.md#debug) - Beta: Get user information
+
 - [`indexingPeopleDelete`](docs/sdks/people/README.md#delete) - Delete employee
 - [`indexingPeopleDeleteTeam`](docs/sdks/people/README.md#deleteteam) - Delete team
 - [`indexingPeopleIndex`](docs/sdks/people/README.md#index) - Index employee
@@ -451,19 +556,10 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`indexingPermissionsProcessMemberships`](docs/sdks/permissions/README.md#processmemberships) - Schedules the processing of group memberships
 - [`indexingPermissionsUpdatePermissions`](docs/sdks/permissions/README.md#updatepermissions) - Update document permissions
 - [`indexingShortcutsBulkIndex`](docs/sdks/indexingshortcuts/README.md#bulkindex) - Bulk index external shortcuts
-- [`indexingTroubleshootingCheckAccess`](docs/sdks/troubleshooting/README.md#checkaccess) - Check document access
-- [`indexingTroubleshootingDebugUser`](docs/sdks/troubleshooting/README.md#debuguser) - Beta: Get user information
-
-- [`indexingTroubleshootingGetDatasourceStatus`](docs/sdks/troubleshooting/README.md#getdatasourcestatus) - Beta: Get datasource status
-
-- [`indexingTroubleshootingPostDocumentDebug`](docs/sdks/troubleshooting/README.md#postdocumentdebug) - Beta: Get document information
-
-- [`indexingTroubleshootingPostDocumentsDebug`](docs/sdks/troubleshooting/README.md#postdocumentsdebug) - Beta: Get information of a batch of documents
-
-- ~~[`indexingPeopleBulkIndex`](docs/sdks/people/README.md#bulkindex)~~ - Bulk index employees :warning: **Deprecated**
-- ~~[`indexingTroubleshootingGetDocumentCount`](docs/sdks/troubleshooting/README.md#getdocumentcount)~~ - Get document count :warning: **Deprecated**
-- ~~[`indexingTroubleshootingGetStatus`](docs/sdks/troubleshooting/README.md#getstatus)~~ - Get document upload and indexing status :warning: **Deprecated**
-- ~~[`indexingTroubleshootingGetUserCount`](docs/sdks/troubleshooting/README.md#getusercount)~~ - Get user count :warning: **Deprecated**
+- [`indexingShortcutsUpload`](docs/sdks/indexingshortcuts/README.md#upload) - Upload shortcuts
+- ~~[`indexingDocumentsCount`](docs/sdks/indexingdocuments/README.md#count)~~ - Get document count :warning: **Deprecated**
+- ~~[`indexingDocumentsStatus`](docs/sdks/indexingdocuments/README.md#status)~~ - Get document upload and indexing status :warning: **Deprecated**
+- ~~[`indexingPeopleCount`](docs/sdks/people/README.md#count)~~ - Get user count :warning: **Deprecated**
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -490,74 +586,83 @@ To learn about this feature and how to get started, check
 
 <summary>Available React hooks</summary>
 
-- [`useAgentsGetagentinputsMutation`](docs/sdks/agents/README.md#getagentinputs) - Gets the inputs to an agent.
-- [`useAgentsListagentsMutation`](docs/sdks/agents/README.md#listagents) - Lists all agents.
-- [`useAgentsRunagentMutation`](docs/sdks/agents/README.md#runagent) - Runs an Agent.
-- [`useClientActivitiesReportActivityMutation`](docs/sdks/activities/README.md#reportactivity) - Report client activity
+- [`useClientActivityFeedbackMutation`](docs/sdks/activity/README.md#feedback) - Report client activity
 - [`useClientActivityReportMutation`](docs/sdks/activity/README.md#report) - Report document activity
+- [`useClientAgentsListMutation`](docs/sdks/agents/README.md#list) - Lists all agents.
+- [`useClientAgentsRetrieveInputsMutation`](docs/sdks/agents/README.md#retrieveinputs) - Gets the inputs to an agent.
+- [`useClientAgentsRunMutation`](docs/sdks/agents/README.md#run) - Runs an Agent.
 - [`useClientAnnouncementsCreateMutation`](docs/sdks/announcements/README.md#create) - Create Announcement
 - [`useClientAnnouncementsDeleteMutation`](docs/sdks/announcements/README.md#delete) - Delete Announcement
 - [`useClientAnnouncementsUpdateMutation`](docs/sdks/announcements/README.md#update) - Update Announcement
 - [`useClientAnswersCreateMutation`](docs/sdks/answers/README.md#create) - Create Answer
 - [`useClientAnswersDeleteMutation`](docs/sdks/answers/README.md#delete) - Delete Answer
-- [`useClientAnswersEditMutation`](docs/sdks/answers/README.md#edit) - Update Answer
-- [`useClientAnswersGetMutation`](docs/sdks/answers/README.md#get) - Read Answer
 - [`useClientAnswersListMutation`](docs/sdks/answers/README.md#list) - List Answers
+- [`useClientAnswersRetrieveMutation`](docs/sdks/answers/README.md#retrieve) - Read Answer
+- [`useClientAnswersUpdateMutation`](docs/sdks/answers/README.md#update) - Update Answer
 - [`useClientAuthenticationCreateTokenMutation`](docs/sdks/clientauthentication/README.md#createtoken) - Create authentication token
+- [`useClientChatCreateMutation`](docs/sdks/chat/README.md#create) - Chat
+- [`useClientChatCreateStreamMutation`](docs/sdks/chat/README.md#createstream) - Chat
 - [`useClientChatDeleteAllMutation`](docs/sdks/chat/README.md#deleteall) - Deletes all saved Chats owned by a user
 - [`useClientChatDeleteFilesMutation`](docs/sdks/chat/README.md#deletefiles) - Delete files uploaded by a user for chat.
 - [`useClientChatDeleteMutation`](docs/sdks/chat/README.md#delete) - Deletes saved Chats
-- [`useClientChatGetApplicationMutation`](docs/sdks/chat/README.md#getapplication) - Gets the metadata for a custom Chat application
-- [`useClientChatGetFilesMutation`](docs/sdks/chat/README.md#getfiles) - Get files uploaded by a user for Chat.
-- [`useClientChatGetMutation`](docs/sdks/chat/README.md#get) - Retrieves a Chat
 - [`useClientChatListMutation`](docs/sdks/chat/README.md#list) - Retrieves all saved Chats
-- [`useClientChatStartMutation`](docs/sdks/chat/README.md#start) - Chat
+- [`useClientChatRetrieveApplicationMutation`](docs/sdks/chat/README.md#retrieveapplication) - Gets the metadata for a custom Chat application
+- [`useClientChatRetrieveFilesMutation`](docs/sdks/chat/README.md#retrievefiles) - Get files uploaded by a user for Chat.
+- [`useClientChatRetrieveMutation`](docs/sdks/chat/README.md#retrieve) - Retrieves a Chat
 - [`useClientChatUploadFilesMutation`](docs/sdks/chat/README.md#uploadfiles) - Upload files for Chat.
 - [`useClientCollectionsAddItemsMutation`](docs/sdks/collections/README.md#additems) - Add Collection item
 - [`useClientCollectionsCreateMutation`](docs/sdks/collections/README.md#create) - Create Collection
 - [`useClientCollectionsDeleteItemMutation`](docs/sdks/collections/README.md#deleteitem) - Delete Collection item
 - [`useClientCollectionsDeleteMutation`](docs/sdks/collections/README.md#delete) - Delete Collection
-- [`useClientCollectionsEditItemMutation`](docs/sdks/collections/README.md#edititem) - Update Collection item
-- [`useClientCollectionsGetMutation`](docs/sdks/collections/README.md#get) - Read Collection
 - [`useClientCollectionsListMutation`](docs/sdks/collections/README.md#list) - List Collections
+- [`useClientCollectionsRetrieveMutation`](docs/sdks/collections/README.md#retrieve) - Read Collection
+- [`useClientCollectionsUpdateItemMutation`](docs/sdks/collections/README.md#updateitem) - Update Collection item
 - [`useClientCollectionsUpdateMutation`](docs/sdks/collections/README.md#update) - Update Collection
-- [`useClientDocumentsGetByFacetsMutation`](docs/sdks/clientdocuments/README.md#getbyfacets) - Read documents by facets
-- [`useClientDocumentsGetMutation`](docs/sdks/clientdocuments/README.md#get) - Read documents
-- [`useClientDocumentsGetPermissionsMutation`](docs/sdks/clientdocuments/README.md#getpermissions) - Read document permissions
+- [`useClientDocumentsRetrieveByFacetsMutation`](docs/sdks/clientdocuments/README.md#retrievebyfacets) - Read documents by facets
+- [`useClientDocumentsRetrieveMutation`](docs/sdks/clientdocuments/README.md#retrieve) - Read documents
+- [`useClientDocumentsRetrievePermissionsMutation`](docs/sdks/clientdocuments/README.md#retrievepermissions) - Read document permissions
+- [`useClientDocumentsSummarizeMutation`](docs/sdks/clientdocuments/README.md#summarize) - Summarize documents
 - [`useClientEntitiesListMutation`](docs/sdks/entities/README.md#list) - List entities
 - [`useClientEntitiesReadPeopleMutation`](docs/sdks/entities/README.md#readpeople) - Read people
-- [`useClientInsightsGetMutation`](docs/sdks/insights/README.md#get) - Read insights
-- [`useClientMessagesGetMutation`](docs/sdks/messages/README.md#get) - Read messages
+- [`useClientInsightsRetrieveMutation`](docs/sdks/insights/README.md#retrieve) - Read insights
+- [`useClientMessagesRetrieveMutation`](docs/sdks/messages/README.md#retrieve) - Read messages
 - [`useClientPinsCreateMutation`](docs/sdks/pins/README.md#create) - Create pin
-- [`useClientPinsEditMutation`](docs/sdks/pins/README.md#edit) - Update pin
-- [`useClientPinsGetMutation`](docs/sdks/pins/README.md#get) - Read pin
 - [`useClientPinsListMutation`](docs/sdks/pins/README.md#list) - List pins
 - [`useClientPinsRemoveMutation`](docs/sdks/pins/README.md#remove) - Delete pin
-- [`useClientSearchAdminMutation`](docs/sdks/search/README.md#admin) - Search the index (admin)
+- [`useClientPinsRetrieveMutation`](docs/sdks/pins/README.md#retrieve) - Read pin
+- [`useClientPinsUpdateMutation`](docs/sdks/pins/README.md#update) - Update pin
 - [`useClientSearchAutocompleteMutation`](docs/sdks/search/README.md#autocomplete) - Autocomplete
-- [`useClientSearchExecuteMutation`](docs/sdks/search/README.md#execute) - Search
-- [`useClientSearchGetFeedMutation`](docs/sdks/search/README.md#getfeed) - Feed of documents and events
+- [`useClientSearchQueryAsAdminMutation`](docs/sdks/search/README.md#queryasadmin) - Search the index (admin)
+- [`useClientSearchQueryMutation`](docs/sdks/search/README.md#query) - Search
 - [`useClientSearchRecommendationsMutation`](docs/sdks/search/README.md#recommendations) - Recommend documents
+- [`useClientSearchRetrieveFeedMutation`](docs/sdks/search/README.md#retrievefeed) - Feed of documents and events
 - [`useClientShortcutsCreateMutation`](docs/sdks/clientshortcuts/README.md#create) - Create shortcut
 - [`useClientShortcutsDeleteMutation`](docs/sdks/clientshortcuts/README.md#delete) - Delete shortcut
-- [`useClientShortcutsGetMutation`](docs/sdks/clientshortcuts/README.md#get) - Read shortcut
 - [`useClientShortcutsListMutation`](docs/sdks/clientshortcuts/README.md#list) - List shortcuts
+- [`useClientShortcutsRetrieveMutation`](docs/sdks/clientshortcuts/README.md#retrieve) - Read shortcut
 - [`useClientShortcutsUpdateMutation`](docs/sdks/clientshortcuts/README.md#update) - Update shortcut
-- [`useClientShortcutsUploadMutation`](docs/sdks/clientshortcuts/README.md#upload) - Upload shortcuts
-- [`useClientSummarizeGenerateMutation`](docs/sdks/summarize/README.md#generate) - Summarize documents
 - [`useClientVerificationAddReminderMutation`](docs/sdks/verification/README.md#addreminder) - Create verification
 - [`useClientVerificationListMutation`](docs/sdks/verification/README.md#list) - List verifications
 - [`useClientVerificationVerifyMutation`](docs/sdks/verification/README.md#verify) - Update verification
 - [`useIndexingAuthenticationRotateTokenMutation`](docs/sdks/indexingauthentication/README.md#rotatetoken) - Rotate token
 - [`useIndexingDatasourcesAddMutation`](docs/sdks/datasources/README.md#add) - Add or update datasource
-- [`useIndexingDatasourcesGetConfigMutation`](docs/sdks/datasources/README.md#getconfig) - Get datasource config
+- [`useIndexingDatasourcesRetrieveConfigMutation`](docs/sdks/datasources/README.md#retrieveconfig) - Get datasource config
+- [`useIndexingDatasourceStatusMutation`](docs/sdks/datasource/README.md#status) - Beta: Get datasource status
+
 - [`useIndexingDocumentsAddOrUpdateMutation`](docs/sdks/indexingdocuments/README.md#addorupdate) - Index document
 - [`useIndexingDocumentsBulkIndexMutation`](docs/sdks/indexingdocuments/README.md#bulkindex) - Bulk index documents
+- [`useIndexingDocumentsCheckAccessMutation`](docs/sdks/indexingdocuments/README.md#checkaccess) - Check document access
+- [`useIndexingDocumentsDebugManyMutation`](docs/sdks/indexingdocuments/README.md#debugmany) - Beta: Get information of a batch of documents
+
+- [`useIndexingDocumentsDebugMutation`](docs/sdks/indexingdocuments/README.md#debug) - Beta: Get document information
+
 - [`useIndexingDocumentsDeleteMutation`](docs/sdks/indexingdocuments/README.md#delete) - Delete document
 - [`useIndexingDocumentsIndexMutation`](docs/sdks/indexingdocuments/README.md#index) - Index documents
 - [`useIndexingDocumentsProcessAllMutation`](docs/sdks/indexingdocuments/README.md#processall) - Schedules the processing of uploaded documents
-- [`useIndexingPeopleBulkIndexEmployeesMutation`](docs/sdks/people/README.md#bulkindexemployees) - Bulk index employees
+- [`useIndexingPeopleBulkIndexMutation`](docs/sdks/people/README.md#bulkindex) - Bulk index employees
 - [`useIndexingPeopleBulkIndexTeamsMutation`](docs/sdks/people/README.md#bulkindexteams) - Bulk index teams
+- [`useIndexingPeopleDebugMutation`](docs/sdks/people/README.md#debug) - Beta: Get user information
+
 - [`useIndexingPeopleDeleteMutation`](docs/sdks/people/README.md#delete) - Delete employee
 - [`useIndexingPeopleDeleteTeamMutation`](docs/sdks/people/README.md#deleteteam) - Delete team
 - [`useIndexingPeopleIndexMutation`](docs/sdks/people/README.md#index) - Index employee
@@ -576,19 +681,10 @@ To learn about this feature and how to get started, check
 - [`useIndexingPermissionsProcessMembershipsMutation`](docs/sdks/permissions/README.md#processmemberships) - Schedules the processing of group memberships
 - [`useIndexingPermissionsUpdatePermissionsMutation`](docs/sdks/permissions/README.md#updatepermissions) - Update document permissions
 - [`useIndexingShortcutsBulkIndexMutation`](docs/sdks/indexingshortcuts/README.md#bulkindex) - Bulk index external shortcuts
-- [`useIndexingTroubleshootingCheckAccessMutation`](docs/sdks/troubleshooting/README.md#checkaccess) - Check document access
-- [`useIndexingTroubleshootingDebugUserMutation`](docs/sdks/troubleshooting/README.md#debuguser) - Beta: Get user information
-
-- [`useIndexingTroubleshootingGetDatasourceStatusMutation`](docs/sdks/troubleshooting/README.md#getdatasourcestatus) - Beta: Get datasource status
-
-- [`useIndexingTroubleshootingPostDocumentDebugMutation`](docs/sdks/troubleshooting/README.md#postdocumentdebug) - Beta: Get document information
-
-- [`useIndexingTroubleshootingPostDocumentsDebugMutation`](docs/sdks/troubleshooting/README.md#postdocumentsdebug) - Beta: Get information of a batch of documents
-
-- ~~[`useIndexingPeopleBulkIndexMutation`](docs/sdks/people/README.md#bulkindex)~~ - Bulk index employees :warning: **Deprecated**
-- ~~[`useIndexingTroubleshootingGetDocumentCountMutation`](docs/sdks/troubleshooting/README.md#getdocumentcount)~~ - Get document count :warning: **Deprecated**
-- ~~[`useIndexingTroubleshootingGetStatusMutation`](docs/sdks/troubleshooting/README.md#getstatus)~~ - Get document upload and indexing status :warning: **Deprecated**
-- ~~[`useIndexingTroubleshootingGetUserCountMutation`](docs/sdks/troubleshooting/README.md#getusercount)~~ - Get user count :warning: **Deprecated**
+- [`useIndexingShortcutsUploadMutation`](docs/sdks/indexingshortcuts/README.md#upload) - Upload shortcuts
+- ~~[`useIndexingDocumentsCountMutation`](docs/sdks/indexingdocuments/README.md#count)~~ - Get document count :warning: **Deprecated**
+- ~~[`useIndexingDocumentsStatusMutation`](docs/sdks/indexingdocuments/README.md#status)~~ - Get document upload and indexing status :warning: **Deprecated**
+- ~~[`useIndexingPeopleCountMutation`](docs/sdks/people/README.md#count)~~ - Get user count :warning: **Deprecated**
 
 </details>
 <!-- End React hooks with TanStack Query [react-query] -->
@@ -603,7 +699,7 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -665,7 +761,7 @@ const glean = new Glean({
     },
     retryConnectionErrors: false,
   },
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -720,11 +816,11 @@ The following errors may be thrown by the SDK:
 ### Example
 
 ```typescript
-import { Glean } from "@gleanwork/api-client";
+import { Glean } from "@gleanwork/api-client";****
 import { GleanDataError, GleanError } from "glean/models/errors";
 
 const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_BEARER_AUTH"] ?? "",
 });
 
 try {
@@ -783,7 +879,7 @@ import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
   domain: "scared-pearl.biz",
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {
@@ -827,7 +923,7 @@ import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
   serverURL: "https://domain-be.glean.com",
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
+  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
 });
 
 async function run() {