@gleanwork/api-client 0.16.0 → 0.17.0

package/src/sdk/clientagents.ts

@@ -3,16 +3,39 @@
  * @generated-id: 7864a10ac52c
  */
 
+import { clientAgentsCreate } from "../funcs/clientAgentsCreate.js";
 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 { clientAgentsUpdate } from "../funcs/clientAgentsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class ClientAgents extends ClientSDK {
+  /**
+   * Create an agent
+   *
+   * @remarks
+   * Create an agent.
+   */
+  async create(
+    createWorkflowRequest: components.CreateWorkflowRequest,
+    locale?: string | undefined,
+    timezoneOffset?: number | undefined,
+    options?: RequestOptions,
+  ): Promise<components.WorkflowResult> {
+    return unwrapAsync(clientAgentsCreate(
+      this,
+      createWorkflowRequest,
+      locale,
+      timezoneOffset,
+      options,
+    ));
+  }
+
   /**
    * Retrieve an agent
    *
@@ -34,6 +57,29 @@ export class ClientAgents extends ClientSDK {
     ));
   }
 
+  /**
+   * Edit an agent
+   *
+   * @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.
+   */
+  async update(
+    editWorkflowRequest: components.EditWorkflowRequest,
+    agentId: string,
+    locale?: string | undefined,
+    timezoneOffset?: number | undefined,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(clientAgentsUpdate(
+      this,
+      editWorkflowRequest,
+      agentId,
+      locale,
+      timezoneOffset,
+      options,
+    ));
+  }
+
   /**
    * List an agent's schemas
    *

package/src/sdk/clientauthentication.ts

@@ -3,12 +3,34 @@
  * @generated-id: dd653d48dc6a
  */
 
+import { clientAuthenticationCheckDatasourceAuth } from "../funcs/clientAuthenticationCheckDatasourceAuth.js";
 import { clientAuthenticationCreateToken } from "../funcs/clientAuthenticationCreateToken.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class ClientAuthentication extends ClientSDK {
+  /**
+   * Check datasource authorization
+   *
+   * @remarks
+   * Returns all datasource instances that require per-user OAuth authorization
+   * for the authenticated user, along with a transient auth token that can be
+   * appended to auth URLs to complete OAuth flows.
+   *
+   * Clients construct the full OAuth URL by combining the backend base URL,
+   * the `authUrlRelativePath` from each instance, and the transient auth token:
+   * `<backend>/<authUrlRelativePath>?transient_auth_token=<token>`.
+   */
+  async checkDatasourceAuth(
+    options?: RequestOptions,
+  ): Promise<components.CheckDatasourceAuthResponse> {
+    return unwrapAsync(clientAuthenticationCheckDatasourceAuth(
+      this,
+      options,
+    ));
+  }
+
   /**
    * Create authentication token
    *

package/src/sdk/clientdatasources.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 18ba361f511a
+ */
+
+import { clientDatasourcesRetrieveConfiguration } from "../funcs/clientDatasourcesRetrieveConfiguration.js";
+import { clientDatasourcesRetrieveCredentialStatus } from "../funcs/clientDatasourcesRetrieveCredentialStatus.js";
+import { clientDatasourcesRotateCredentials } from "../funcs/clientDatasourcesRotateCredentials.js";
+import { clientDatasourcesUpdateConfiguration } from "../funcs/clientDatasourcesUpdateConfiguration.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class ClientDatasources extends ClientSDK {
+  /**
+   * Get datasource instance configuration
+   *
+   * @remarks
+   * Gets the greenlisted configuration values for a datasource instance. Returns only configuration keys that are exposed via the public API greenlist.
+   */
+  async retrieveConfiguration(
+    datasourceId: string,
+    instanceId: string,
+    options?: RequestOptions,
+  ): Promise<components.DatasourceConfigurationResponse> {
+    return unwrapAsync(clientDatasourcesRetrieveConfiguration(
+      this,
+      datasourceId,
+      instanceId,
+      options,
+    ));
+  }
+
+  /**
+   * Update datasource instance configuration
+   *
+   * @remarks
+   * Updates the greenlisted configuration values for a datasource instance. Only configuration keys that are exposed via the public API greenlist may be set. Returns the full greenlisted configuration after the update is applied.
+   */
+  async updateConfiguration(
+    updateDatasourceConfigurationRequest:
+      components.UpdateDatasourceConfigurationRequest,
+    datasourceId: string,
+    instanceId: string,
+    options?: RequestOptions,
+  ): Promise<components.DatasourceConfigurationResponse> {
+    return unwrapAsync(clientDatasourcesUpdateConfiguration(
+      this,
+      updateDatasourceConfigurationRequest,
+      datasourceId,
+      instanceId,
+      options,
+    ));
+  }
+
+  /**
+   * Get datasource instance credential status
+   *
+   * @remarks
+   * Returns the current credential status for a datasource instance. Access is limited to callers with the ADMIN scope; the handler enforces this check.
+   */
+  async retrieveCredentialStatus(
+    datasourceInstanceId: string,
+    options?: RequestOptions,
+  ): Promise<components.DatasourceCredentialStatusResponse> {
+    return unwrapAsync(clientDatasourcesRetrieveCredentialStatus(
+      this,
+      datasourceInstanceId,
+      options,
+    ));
+  }
+
+  /**
+   * Rotate datasource instance credentials
+   *
+   * @remarks
+   * Rotates the credentials that a datasource instance uses to connect to its upstream system. Replaces the active credential material with the supplied values and returns the credential status after rotation. Access is limited to callers with the ADMIN scope; the handler enforces this check.
+   * Only keys recognized as credential material for the datasource type may be set in `credentials.values` (e.g. `clientSecret`, `apiToken`, `privateKey`, depending on the configured auth method). Unrecognized keys, or keys that correspond to non-credential configuration, cause a 400; other instance configuration must be updated via PATCH /configure/datasources/{datasourceId}/instances/{instanceId}.
+   */
+  async rotateCredentials(
+    rotateDatasourceCredentialsRequest:
+      components.RotateDatasourceCredentialsRequest,
+    datasourceInstanceId: string,
+    options?: RequestOptions,
+  ): Promise<components.DatasourceCredentialStatusResponse> {
+    return unwrapAsync(clientDatasourcesRotateCredentials(
+      this,
+      rotateDatasourceCredentialsRequest,
+      datasourceInstanceId,
+      options,
+    ));
+  }
+}

package/src/sdk/clientsearch.ts

@@ -0,0 +1,110 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9d303135a965
+ */
+
+import { clientSearchAutocomplete } from "../funcs/clientSearchAutocomplete.js";
+import { clientSearchQuery } from "../funcs/clientSearchQuery.js";
+import { clientSearchQueryAsAdmin } from "../funcs/clientSearchQueryAsAdmin.js";
+import { clientSearchRecommendations } from "../funcs/clientSearchRecommendations.js";
+import { clientSearchRetrieveFeed } from "../funcs/clientSearchRetrieveFeed.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class ClientSearch extends ClientSDK {
+  /**
+   * Search the index (admin)
+   *
+   * @remarks
+   * Retrieves results for search query without respect for permissions. This is available only to privileged users.
+   */
+  async queryAsAdmin(
+    searchRequest: components.SearchRequest,
+    locale?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.SearchResponse> {
+    return unwrapAsync(clientSearchQueryAsAdmin(
+      this,
+      searchRequest,
+      locale,
+      options,
+    ));
+  }
+
+  /**
+   * Autocomplete
+   *
+   * @remarks
+   * Retrieve query suggestions, operators and documents for the given partially typed query.
+   */
+  async autocomplete(
+    autocompleteRequest: components.AutocompleteRequest,
+    locale?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.AutocompleteResponse> {
+    return unwrapAsync(clientSearchAutocomplete(
+      this,
+      autocompleteRequest,
+      locale,
+      options,
+    ));
+  }
+
+  /**
+   * Feed of documents and events
+   *
+   * @remarks
+   * The personalized feed/home includes different types of contents including suggestions, recents, calendar events and many more.
+   */
+  async retrieveFeed(
+    feedRequest: components.FeedRequest,
+    locale?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.FeedResponse> {
+    return unwrapAsync(clientSearchRetrieveFeed(
+      this,
+      feedRequest,
+      locale,
+      options,
+    ));
+  }
+
+  /**
+   * Recommend documents
+   *
+   * @remarks
+   * Retrieve recommended documents for the given URL or Glean Document ID.
+   */
+  async recommendations(
+    recommendationsRequest: components.RecommendationsRequest,
+    locale?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.ResultsResponse | undefined> {
+    return unwrapAsync(clientSearchRecommendations(
+      this,
+      recommendationsRequest,
+      locale,
+      options,
+    ));
+  }
+
+  /**
+   * Search
+   *
+   * @remarks
+   * Retrieve results from the index for the given query and filters.
+   */
+  async query(
+    searchRequest: components.SearchRequest,
+    locale?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.SearchResponse> {
+    return unwrapAsync(clientSearchQuery(
+      this,
+      searchRequest,
+      locale,
+      options,
+    ));
+  }
+}

package/src/sdk/data.ts

@@ -4,6 +4,7 @@
  */
 
 import { ClientSDK } from "../lib/sdks.js";
+import { Findings } from "./findings.js";
 import { Policies } from "./policies.js";
 import { Reports } from "./reports.js";
 
@@ -17,4 +18,9 @@ export class Data extends ClientSDK {
   get reports(): Reports {
     return (this._reports ??= new Reports(this._options));
   }
+
+  private _findings?: Findings;
+  get findings(): Findings {
+    return (this._findings ??= new Findings(this._options));
+  }
 }

package/src/sdk/entities.ts

@@ -3,31 +3,72 @@
  * @generated-id: 71997b5f9b62
  */
 
+import { clientEntitiesList } from "../funcs/clientEntitiesList.js";
+import { clientEntitiesReadPeople } from "../funcs/clientEntitiesReadPeople.js";
 import {
-  entitiesGetPersonPhoto,
-  GetPersonPhotoAcceptEnum,
-} from "../funcs/entitiesGetPersonPhoto.js";
+  clientEntitiesRetrievePersonPhoto,
+  RetrievePersonPhotoAcceptEnum,
+} from "../funcs/clientEntitiesRetrievePersonPhoto.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 { GetPersonPhotoAcceptEnum } from "../funcs/entitiesGetPersonPhoto.js";
+export { RetrievePersonPhotoAcceptEnum } from "../funcs/clientEntitiesRetrievePersonPhoto.js";
 
 export class Entities extends ClientSDK {
+  /**
+   * List entities
+   *
+   * @remarks
+   * List some set of details for all entities that fit the given criteria and return in the requested order. Does not support negation in filters, assumes relation type EQUALS. There is a limit of 10000 entities that can be retrieved via this endpoint, except when using FULL_DIRECTORY request type for people entities.
+   */
+  async list(
+    listEntitiesRequest: components.ListEntitiesRequest,
+    locale?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.ListEntitiesResponse> {
+    return unwrapAsync(clientEntitiesList(
+      this,
+      listEntitiesRequest,
+      locale,
+      options,
+    ));
+  }
+
+  /**
+   * Read people
+   *
+   * @remarks
+   * Read people details for the given IDs.
+   */
+  async readPeople(
+    peopleRequest: components.PeopleRequest,
+    locale?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<components.PeopleResponse> {
+    return unwrapAsync(clientEntitiesReadPeople(
+      this,
+      peopleRequest,
+      locale,
+      options,
+    ));
+  }
+
   /**
    * Get person photo
    *
    * @remarks
    * Returns the profile photo bytes for a person whose photo is stored in Glean (crawled from an identity source or user-uploaded via admin console). Photos hosted externally (e.g. Slack CDN) are not served by this endpoint; callers should follow the photoUrl from /people or /listentities directly. Responses include a Cache-Control header (max-age=3600) to reduce redundant fetches.
    */
-  async getPersonPhoto(
+  async retrievePersonPhoto(
     personId: string,
     ds?: string | undefined,
     options?: RequestOptions & {
-      acceptHeaderOverride?: GetPersonPhotoAcceptEnum;
+      acceptHeaderOverride?: RetrievePersonPhotoAcceptEnum;
     },
   ): Promise<operations.GetPersonPhotoResponse> {
-    return unwrapAsync(entitiesGetPersonPhoto(
+    return unwrapAsync(clientEntitiesRetrievePersonPhoto(
       this,
       personId,
       ds,

package/src/sdk/findings.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 53fa822d455a
+ */
+
+import { clientGovernanceDataFindingsCreate } from "../funcs/clientGovernanceDataFindingsCreate.js";
+import { clientGovernanceDataFindingsDelete } from "../funcs/clientGovernanceDataFindingsDelete.js";
+import { clientGovernanceDataFindingsDownload } from "../funcs/clientGovernanceDataFindingsDownload.js";
+import { clientGovernanceDataFindingsList } from "../funcs/clientGovernanceDataFindingsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Findings extends ClientSDK {
+  /**
+   * Creates findings export
+   *
+   * @remarks
+   * Creates a new DLP findings export job.
+   */
+  async create(
+    request: components.DlpExportFindingsRequest,
+    options?: RequestOptions,
+  ): Promise<components.ExportInfo> {
+    return unwrapAsync(clientGovernanceDataFindingsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Lists findings exports
+   *
+   * @remarks
+   * Lists all DLP findings exports.
+   */
+  async list(
+    options?: RequestOptions,
+  ): Promise<components.ListDlpFindingsExportsResponse> {
+    return unwrapAsync(clientGovernanceDataFindingsList(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Downloads findings export
+   *
+   * @remarks
+   * Downloads a DLP findings export as a CSV file.
+   */
+  async download(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<string> {
+    return unwrapAsync(clientGovernanceDataFindingsDownload(
+      this,
+      id,
+      options,
+    ));
+  }
+
+  /**
+   * Deletes findings export
+   *
+   * @remarks
+   * Deletes a DLP findings export.
+   */
+  async delete(
+    id: number,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(clientGovernanceDataFindingsDelete(
+      this,
+      id,
+      options,
+    ));
+  }
+}

package/src/sdk/governance.ts

@@ -3,78 +3,18 @@
  * @generated-id: b7de258afd95
  */
 
-import { governanceCreatefindingsexport } from "../funcs/governanceCreatefindingsexport.js";
-import { governanceDeletefindingsexport } from "../funcs/governanceDeletefindingsexport.js";
-import { governanceDownloadfindingsexport } from "../funcs/governanceDownloadfindingsexport.js";
-import { governanceListfindingsexports } from "../funcs/governanceListfindingsexports.js";
-import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as components from "../models/components/index.js";
-import { unwrapAsync } from "../types/fp.js";
+import { ClientSDK } from "../lib/sdks.js";
+import { Data } from "./data.js";
+import { GovernanceDocuments } from "./governancedocuments.js";
 
 export class Governance extends ClientSDK {
-  /**
-   * Creates findings export
-   *
-   * @remarks
-   * Creates a new DLP findings export job.
-   */
-  async createfindingsexport(
-    request: components.DlpExportFindingsRequest,
-    options?: RequestOptions,
-  ): Promise<components.ExportInfo> {
-    return unwrapAsync(governanceCreatefindingsexport(
-      this,
-      request,
-      options,
-    ));
+  private _data?: Data;
+  get data(): Data {
+    return (this._data ??= new Data(this._options));
   }
 
-  /**
-   * Lists findings exports
-   *
-   * @remarks
-   * Lists all DLP findings exports.
-   */
-  async listfindingsexports(
-    options?: RequestOptions,
-  ): Promise<components.ListDlpFindingsExportsResponse> {
-    return unwrapAsync(governanceListfindingsexports(
-      this,
-      options,
-    ));
-  }
-
-  /**
-   * Downloads findings export
-   *
-   * @remarks
-   * Downloads a DLP findings export as a CSV file.
-   */
-  async downloadfindingsexport(
-    id: string,
-    options?: RequestOptions,
-  ): Promise<string> {
-    return unwrapAsync(governanceDownloadfindingsexport(
-      this,
-      id,
-      options,
-    ));
-  }
-
-  /**
-   * Deletes findings export
-   *
-   * @remarks
-   * Deletes a DLP findings export.
-   */
-  async deletefindingsexport(
-    id: number,
-    options?: RequestOptions,
-  ): Promise<void> {
-    return unwrapAsync(governanceDeletefindingsexport(
-      this,
-      id,
-      options,
-    ));
+  private _documents?: GovernanceDocuments;
+  get documents(): GovernanceDocuments {
+    return (this._documents ??= new GovernanceDocuments(this._options));
   }
 }

package/src/sdk/indexingdocuments.ts

@@ -8,6 +8,7 @@ import { indexingDocumentsBulkIndex } from "../funcs/indexingDocumentsBulkIndex.
 import { indexingDocumentsCheckAccess } from "../funcs/indexingDocumentsCheckAccess.js";
 import { indexingDocumentsCount } from "../funcs/indexingDocumentsCount.js";
 import { indexingDocumentsDebug } from "../funcs/indexingDocumentsDebug.js";
+import { indexingDocumentsDebugEvents } from "../funcs/indexingDocumentsDebugEvents.js";
 import { indexingDocumentsDebugMany } from "../funcs/indexingDocumentsDebugMany.js";
 import { indexingDocumentsDelete } from "../funcs/indexingDocumentsDelete.js";
 import { indexingDocumentsIndex } from "../funcs/indexingDocumentsIndex.js";
@@ -215,4 +216,23 @@ export class IndexingDocuments extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * 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.
+   */
+  async debugEvents(
+    debugDocumentLifecycleRequest: components.DebugDocumentLifecycleRequest,
+    datasource: string,
+    options?: RequestOptions,
+  ): Promise<components.DebugDocumentLifecycleResponse> {
+    return unwrapAsync(indexingDocumentsDebugEvents(
+      this,
+      debugDocumentLifecycleRequest,
+      datasource,
+      options,
+    ));
+  }
 }

package/src/sdk/sdk.ts

@@ -5,64 +5,28 @@
 
 import { ClientSDK } from "../lib/sdks.js";
 import { Agents } from "./agents.js";
-import { Authentication } from "./authentication.js";
-import { Chat } from "./chat.js";
 import { Client } from "./client.js";
-import { Datasources } from "./datasources.js";
-import { Entities } from "./entities.js";
-import { Governance } from "./governance.js";
 import { Indexing } from "./indexing.js";
-import { Tools } from "./tools.js";
-import { Troubleshooting } from "./troubleshooting.js";
+import { Search } from "./search.js";
 
 export class Glean extends ClientSDK {
-  private _client?: Client;
-  get client(): Client {
-    return (this._client ??= new Client(this._options));
-  }
-
-  private _authentication?: Authentication;
-  get authentication(): Authentication {
-    return (this._authentication ??= new Authentication(this._options));
-  }
-
-  private _chat?: Chat;
-  get chat(): Chat {
-    return (this._chat ??= new Chat(this._options));
-  }
-
   private _agents?: Agents;
   get agents(): Agents {
     return (this._agents ??= new Agents(this._options));
   }
 
-  private _entities?: Entities;
-  get entities(): Entities {
-    return (this._entities ??= new Entities(this._options));
+  private _search?: Search;
+  get search(): Search {
+    return (this._search ??= new Search(this._options));
   }
 
-  private _tools?: Tools;
-  get tools(): Tools {
-    return (this._tools ??= new Tools(this._options));
+  private _client?: Client;
+  get client(): Client {
+    return (this._client ??= new Client(this._options));
   }
 
   private _indexing?: Indexing;
   get indexing(): Indexing {
     return (this._indexing ??= new Indexing(this._options));
   }
-
-  private _troubleshooting?: Troubleshooting;
-  get troubleshooting(): Troubleshooting {
-    return (this._troubleshooting ??= new Troubleshooting(this._options));
-  }
-
-  private _governance?: Governance;
-  get governance(): Governance {
-    return (this._governance ??= new Governance(this._options));
-  }
-
-  private _datasources?: Datasources;
-  get datasources(): Datasources {
-    return (this._datasources ??= new Datasources(this._options));
-  }
 }