@gleanwork/api-client 0.1.0-beta.7 → 0.1.0-beta.9

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@gleanwork/api-client",
-  "version": "0.1.0-beta.7",
+  "version": "0.1.0-beta.9",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gleanwork/api-client",
-  "version": "0.1.0-beta.7",
+  "version": "0.1.0-beta.9",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {

package/src/__tests__/adminsearch.test.ts

@@ -16,7 +16,7 @@ test("Admin Search Adminsearch", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.admin.search.query({
+  const result = await glean.client.search.queryAsAdmin({
     trackingToken: "trackingToken",
     sourceDocument: {
       metadata: {

package/src/__tests__/search.test.ts

@@ -15,7 +15,7 @@ test("Search Autocomplete", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.search.autocomplete({
+  const result = await glean.client.search.autocomplete({
     trackingToken: "trackingToken",
     query: "San Fra",
     datasource: "GDRIVE",

package/src/funcs/{searchAutocomplete.ts → clientSearchAutocomplete.ts}

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Retrieve query suggestions, operators and documents for the given partially typed query.
  */
-export function searchAutocomplete(
+export function clientSearchAutocomplete(
   client: GleanCore,
   request: components.AutocompleteRequest,
   options?: RequestOptions,

package/src/funcs/{clientAdminSearchQuery.ts → clientSearchQueryAsAdmin.ts}

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Retrieves results for search query without respect for permissions. This is available only to privileged users.
  */
-export function clientAdminSearchQuery(
+export function clientSearchQueryAsAdmin(
   client: GleanCore,
   request?: components.SearchRequest | undefined,
   options?: RequestOptions,

package/src/funcs/indexingPeopleBulkIndex.ts

@@ -28,13 +28,11 @@ import { Result } from "../types/fp.js";
  * Bulk index employees
  *
  * @remarks
- * Bulk upload details of all the employees. This deletes all employees uploaded in the prior batch. SOON TO BE DEPRECATED in favor of /bulkindexemployees.
- *
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints.
  */
 export function indexingPeopleBulkIndex(
   client: GleanCore,
-  request: components.IndexEmployeeListRequest,
+  request: components.BulkIndexEmployeesRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -57,7 +55,7 @@ export function indexingPeopleBulkIndex(
 
 async function $do(
   client: GleanCore,
-  request: components.IndexEmployeeListRequest,
+  request: components.BulkIndexEmployeesRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -76,7 +74,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => components.IndexEmployeeListRequest$outboundSchema.parse(value),
+    (value) => components.BulkIndexEmployeesRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -85,7 +83,7 @@ async function $do(
   const payload = parsed.value;
   const body = encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/api/index/v1/indexemployeelist")();
+  const path = pathToFunc("/api/index/v1/bulkindexemployees")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -98,7 +96,7 @@ async function $do(
 
   const context = {
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "post_/api/index/v1/indexemployeelist",
+    operationID: "post_/api/index/v1/bulkindexemployees",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,

package/src/lib/config.ts

@@ -64,8 +64,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.9.0",
-  sdkVersion: "0.1.0-beta.7",
+  sdkVersion: "0.1.0-beta.9",
   genVersion: "2.597.9",
   userAgent:
-    "speakeasy-sdk/typescript 0.1.0-beta.7 2.597.9 0.9.0 @gleanwork/api-client",
+    "speakeasy-sdk/typescript 0.1.0-beta.9 2.597.9 0.9.0 @gleanwork/api-client",
 } as const;

package/src/models/components/index.ts

@@ -220,7 +220,6 @@ export * from "./grouptype.js";
 export * from "./iconconfig.js";
 export * from "./indexdocumentrequest.js";
 export * from "./indexdocumentsrequest.js";
-export * from "./indexemployeelistrequest.js";
 export * from "./indexemployeerequest.js";
 export * from "./indexgrouprequest.js";
 export * from "./indexingshortcut.js";

package/src/react-query/{searchAutocomplete.ts → clientSearchAutocomplete.ts}

@@ -8,7 +8,7 @@ import {
   UseMutationResult,
 } from "@tanstack/react-query";
 import { GleanCore } from "../core.js";
-import { searchAutocomplete } from "../funcs/searchAutocomplete.js";
+import { clientSearchAutocomplete } from "../funcs/clientSearchAutocomplete.js";
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -16,12 +16,13 @@ import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
-export type SearchAutocompleteMutationVariables = {
+export type ClientSearchAutocompleteMutationVariables = {
   request: components.AutocompleteRequest;
   options?: RequestOptions;
 };
 
-export type SearchAutocompleteMutationData = components.AutocompleteResponse;
+export type ClientSearchAutocompleteMutationData =
+  components.AutocompleteResponse;
 
 /**
  * Autocomplete
@@ -29,43 +30,43 @@ export type SearchAutocompleteMutationData = components.AutocompleteResponse;
  * @remarks
  * Retrieve query suggestions, operators and documents for the given partially typed query.
  */
-export function useSearchAutocompleteMutation(
+export function useClientSearchAutocompleteMutation(
   options?: MutationHookOptions<
-    SearchAutocompleteMutationData,
+    ClientSearchAutocompleteMutationData,
     Error,
-    SearchAutocompleteMutationVariables
+    ClientSearchAutocompleteMutationVariables
   >,
 ): UseMutationResult<
-  SearchAutocompleteMutationData,
+  ClientSearchAutocompleteMutationData,
   Error,
-  SearchAutocompleteMutationVariables
+  ClientSearchAutocompleteMutationVariables
 > {
   const client = useGleanContext();
   return useMutation({
-    ...buildSearchAutocompleteMutation(client, options),
+    ...buildClientSearchAutocompleteMutation(client, options),
     ...options,
   });
 }
 
-export function mutationKeySearchAutocomplete(): MutationKey {
-  return ["@gleanwork/api-client", "Search", "autocomplete"];
+export function mutationKeyClientSearchAutocomplete(): MutationKey {
+  return ["@gleanwork/api-client", "search", "autocomplete"];
 }
 
-export function buildSearchAutocompleteMutation(
+export function buildClientSearchAutocompleteMutation(
   client$: GleanCore,
   hookOptions?: RequestOptions,
 ): {
   mutationKey: MutationKey;
   mutationFn: (
-    variables: SearchAutocompleteMutationVariables,
-  ) => Promise<SearchAutocompleteMutationData>;
+    variables: ClientSearchAutocompleteMutationVariables,
+  ) => Promise<ClientSearchAutocompleteMutationData>;
 } {
   return {
-    mutationKey: mutationKeySearchAutocomplete(),
-    mutationFn: function searchAutocompleteMutationFn({
+    mutationKey: mutationKeyClientSearchAutocomplete(),
+    mutationFn: function clientSearchAutocompleteMutationFn({
       request,
       options,
-    }): Promise<SearchAutocompleteMutationData> {
+    }): Promise<ClientSearchAutocompleteMutationData> {
       const mergedOptions = {
         ...hookOptions,
         ...options,
@@ -78,7 +79,7 @@ export function buildSearchAutocompleteMutation(
           ),
         },
       };
-      return unwrapAsync(searchAutocomplete(
+      return unwrapAsync(clientSearchAutocomplete(
         client$,
         request,
         mergedOptions,

package/src/react-query/{clientAdminSearchQuery.ts → clientSearchQueryAsAdmin.ts}

@@ -8,7 +8,7 @@ import {
   UseMutationResult,
 } from "@tanstack/react-query";
 import { GleanCore } from "../core.js";
-import { clientAdminSearchQuery } from "../funcs/clientAdminSearchQuery.js";
+import { clientSearchQueryAsAdmin } from "../funcs/clientSearchQueryAsAdmin.js";
 import { combineSignals } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -16,12 +16,12 @@ import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
-export type ClientAdminSearchQueryMutationVariables = {
+export type ClientSearchQueryAsAdminMutationVariables = {
   request?: components.SearchRequest | undefined;
   options?: RequestOptions;
 };
 
-export type ClientAdminSearchQueryMutationData = components.SearchResponse;
+export type ClientSearchQueryAsAdminMutationData = components.SearchResponse;
 
 /**
  * Search the index (admin)
@@ -29,43 +29,43 @@ export type ClientAdminSearchQueryMutationData = components.SearchResponse;
  * @remarks
  * Retrieves results for search query without respect for permissions. This is available only to privileged users.
  */
-export function useClientAdminSearchQueryMutation(
+export function useClientSearchQueryAsAdminMutation(
   options?: MutationHookOptions<
-    ClientAdminSearchQueryMutationData,
+    ClientSearchQueryAsAdminMutationData,
     Error,
-    ClientAdminSearchQueryMutationVariables
+    ClientSearchQueryAsAdminMutationVariables
   >,
 ): UseMutationResult<
-  ClientAdminSearchQueryMutationData,
+  ClientSearchQueryAsAdminMutationData,
   Error,
-  ClientAdminSearchQueryMutationVariables
+  ClientSearchQueryAsAdminMutationVariables
 > {
   const client = useGleanContext();
   return useMutation({
-    ...buildClientAdminSearchQueryMutation(client, options),
+    ...buildClientSearchQueryAsAdminMutation(client, options),
     ...options,
   });
 }
 
-export function mutationKeyClientAdminSearchQuery(): MutationKey {
-  return ["@gleanwork/api-client", "search", "query"];
+export function mutationKeyClientSearchQueryAsAdmin(): MutationKey {
+  return ["@gleanwork/api-client", "search", "queryAsAdmin"];
 }
 
-export function buildClientAdminSearchQueryMutation(
+export function buildClientSearchQueryAsAdminMutation(
   client$: GleanCore,
   hookOptions?: RequestOptions,
 ): {
   mutationKey: MutationKey;
   mutationFn: (
-    variables: ClientAdminSearchQueryMutationVariables,
-  ) => Promise<ClientAdminSearchQueryMutationData>;
+    variables: ClientSearchQueryAsAdminMutationVariables,
+  ) => Promise<ClientSearchQueryAsAdminMutationData>;
 } {
   return {
-    mutationKey: mutationKeyClientAdminSearchQuery(),
-    mutationFn: function clientAdminSearchQueryMutationFn({
+    mutationKey: mutationKeyClientSearchQueryAsAdmin(),
+    mutationFn: function clientSearchQueryAsAdminMutationFn({
       request,
       options,
-    }): Promise<ClientAdminSearchQueryMutationData> {
+    }): Promise<ClientSearchQueryAsAdminMutationData> {
       const mergedOptions = {
         ...hookOptions,
         ...options,
@@ -78,7 +78,7 @@ export function buildClientAdminSearchQueryMutation(
           ),
         },
       };
-      return unwrapAsync(clientAdminSearchQuery(
+      return unwrapAsync(clientSearchQueryAsAdmin(
         client$,
         request,
         mergedOptions,

package/src/react-query/index.ts

@@ -7,7 +7,6 @@ export * from "./_types.js";
 
 export * from "./clientActivityFeedback.js";
 export * from "./clientActivityReport.js";
-export * from "./clientAdminSearchQuery.js";
 export * from "./clientAgentsList.js";
 export * from "./clientAgentsRetrieveInputs.js";
 export * from "./clientAgentsRun.js";
@@ -51,7 +50,9 @@ export * from "./clientPinsList.js";
 export * from "./clientPinsRemove.js";
 export * from "./clientPinsRetrieve.js";
 export * from "./clientPinsUpdate.js";
+export * from "./clientSearchAutocomplete.js";
 export * from "./clientSearchQuery.js";
+export * from "./clientSearchQueryAsAdmin.js";
 export * from "./clientSearchRecommendations.js";
 export * from "./clientSearchRetrieveFeed.js";
 export * from "./clientShortcutsCreate.js";
@@ -99,5 +100,3 @@ export * from "./indexingPermissionsProcessMemberships.js";
 export * from "./indexingPermissionsUpdatePermissions.js";
 export * from "./indexingShortcutsBulkIndex.js";
 export * from "./indexingShortcutsUpload.js";
-export * from "./peoplePostApiIndexV1Bulkindexemployees.js";
-export * from "./searchAutocomplete.js";

package/src/react-query/indexingPeopleBulkIndex.ts

@@ -17,7 +17,7 @@ import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type IndexingPeopleBulkIndexMutationVariables = {
-  request: components.IndexEmployeeListRequest;
+  request: components.BulkIndexEmployeesRequest;
   options?: RequestOptions;
 };
 
@@ -27,9 +27,7 @@ export type IndexingPeopleBulkIndexMutationData = void;
  * Bulk index employees
  *
  * @remarks
- * Bulk upload details of all the employees. This deletes all employees uploaded in the prior batch. SOON TO BE DEPRECATED in favor of /bulkindexemployees.
- *
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints.
  */
 export function useIndexingPeopleBulkIndexMutation(
   options?: MutationHookOptions<

package/src/sdk/client.ts

@@ -4,20 +4,19 @@
 
 import { ClientSDK } from "../lib/sdks.js";
 import { Activity } from "./activity.js";
-import { Admin } from "./admin.js";
 import { Agents } from "./agents.js";
 import { Announcements } from "./announcements.js";
 import { Answers } from "./answers.js";
 import { Chat } from "./chat.js";
 import { ClientAuthentication } from "./clientauthentication.js";
 import { ClientDocuments } from "./clientdocuments.js";
-import { ClientSearch } from "./clientsearch.js";
 import { ClientShortcuts } from "./clientshortcuts.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 { Verification } from "./verification.js";
 
 export class Client extends ClientSDK {
@@ -76,14 +75,9 @@ export class Client extends ClientSDK {
     return (this._pins ??= new Pins(this._options));
   }
 
-  private _admin?: Admin;
-  get admin(): Admin {
-    return (this._admin ??= new Admin(this._options));
-  }
-
-  private _search?: ClientSearch;
-  get search(): ClientSearch {
-    return (this._search ??= new ClientSearch(this._options));
+  private _search?: Search;
+  get search(): Search {
+    return (this._search ??= new Search(this._options));
   }
 
   private _entities?: Entities;

package/src/sdk/indexing.ts

@@ -7,8 +7,8 @@ import { Datasource } from "./datasource.js";
 import { Datasources } from "./datasources.js";
 import { IndexingAuthentication } from "./indexingauthentication.js";
 import { IndexingDocuments } from "./indexingdocuments.js";
-import { IndexingPeople } from "./indexingpeople.js";
 import { IndexingShortcuts } from "./indexingshortcuts.js";
+import { People } from "./people.js";
 import { Permissions } from "./permissions.js";
 
 export class Indexing extends ClientSDK {
@@ -27,9 +27,9 @@ export class Indexing extends ClientSDK {
     return (this._datasource ??= new Datasource(this._options));
   }
 
-  private _people?: IndexingPeople;
-  get people(): IndexingPeople {
-    return (this._people ??= new IndexingPeople(this._options));
+  private _people?: People;
+  get people(): People {
+    return (this._people ??= new People(this._options));
   }
 
   private _datasources?: Datasources;

package/src/sdk/people.ts

@@ -2,23 +2,173 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { peoplePostApiIndexV1Bulkindexemployees } from "../funcs/peoplePostApiIndexV1Bulkindexemployees.js";
+import { indexingPeopleBulkIndex } from "../funcs/indexingPeopleBulkIndex.js";
+import { indexingPeopleBulkIndexTeams } from "../funcs/indexingPeopleBulkIndexTeams.js";
+import { indexingPeopleCount } from "../funcs/indexingPeopleCount.js";
+import { indexingPeopleDebug } from "../funcs/indexingPeopleDebug.js";
+import { indexingPeopleDelete } from "../funcs/indexingPeopleDelete.js";
+import { indexingPeopleDeleteTeam } from "../funcs/indexingPeopleDeleteTeam.js";
+import { indexingPeopleIndex } from "../funcs/indexingPeopleIndex.js";
+import { indexingPeopleIndexTeam } from "../funcs/indexingPeopleIndexTeam.js";
+import { indexingPeopleProcessAllEmployeesAndTeams } from "../funcs/indexingPeopleProcessAllEmployeesAndTeams.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class People extends ClientSDK {
+  /**
+   * Beta: Get user information
+   *
+   * @remarks
+   * Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice.
+   *
+   * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information.
+   */
+  async debug(
+    debugUserRequest: components.DebugUserRequest,
+    datasource: string,
+    options?: RequestOptions,
+  ): Promise<components.DebugUserResponse> {
+    return unwrapAsync(indexingPeopleDebug(
+      this,
+      debugUserRequest,
+      datasource,
+      options,
+    ));
+  }
+
+  /**
+   * Get user count
+   *
+   * @remarks
+   * Fetches user count for the specified custom datasource.
+   *
+   * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information.
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  async count(
+    request: components.GetUserCountRequest,
+    options?: RequestOptions,
+  ): Promise<components.GetUserCountResponse> {
+    return unwrapAsync(indexingPeopleCount(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Index employee
+   *
+   * @remarks
+   * Adds an employee or updates information about an employee
+   */
+  async index(
+    request: components.IndexEmployeeRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(indexingPeopleIndex(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Bulk index employees
    *
    * @remarks
    * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints.
    */
-  async postApiIndexV1Bulkindexemployees(
+  async bulkIndex(
     request: components.BulkIndexEmployeesRequest,
     options?: RequestOptions,
   ): Promise<void> {
-    return unwrapAsync(peoplePostApiIndexV1Bulkindexemployees(
+    return unwrapAsync(indexingPeopleBulkIndex(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Schedules the processing of uploaded employees and teams
+   *
+   * @remarks
+   * Schedules the immediate processing of employees and teams uploaded through the indexing API. By default all uploaded people data will be processed asynchronously but this API can be used to schedule its processing on demand.
+   */
+  async processAllEmployeesAndTeams(
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(indexingPeopleProcessAllEmployeesAndTeams(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Delete employee
+   *
+   * @remarks
+   * Delete an employee. Silently succeeds if employee is not present.
+   */
+  async delete(
+    request: components.DeleteEmployeeRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(indexingPeopleDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Index team
+   *
+   * @remarks
+   * Adds a team or updates information about a team
+   */
+  async indexTeam(
+    request: components.IndexTeamRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(indexingPeopleIndexTeam(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete team
+   *
+   * @remarks
+   * Delete a team based on provided id.
+   */
+  async deleteTeam(
+    request: components.DeleteTeamRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(indexingPeopleDeleteTeam(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Bulk index teams
+   *
+   * @remarks
+   * Replaces all the currently indexed teams using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints.
+   */
+  async bulkIndexTeams(
+    request: components.BulkIndexTeamsRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(indexingPeopleBulkIndexTeams(
       this,
       request,
       options,

package/src/sdk/sdk.ts

@@ -5,8 +5,6 @@
 import { ClientSDK } from "../lib/sdks.js";
 import { Client } from "./client.js";
 import { Indexing } from "./indexing.js";
-import { People } from "./people.js";
-import { Search } from "./search.js";
 
 export class Glean extends ClientSDK {
   private _client?: Client;
@@ -14,18 +12,8 @@ export class Glean extends ClientSDK {
     return (this._client ??= new Client(this._options));
   }
 
-  private _search?: Search;
-  get search(): Search {
-    return (this._search ??= new Search(this._options));
-  }
-
   private _indexing?: Indexing;
   get indexing(): Indexing {
     return (this._indexing ??= new Indexing(this._options));
   }
-
-  private _people?: People;
-  get people(): People {
-    return (this._people ??= new People(this._options));
-  }
 }