@gleanwork/api-client 0.1.0-beta.4 → 0.1.0-beta.6

package/src/sdk/clientdocuments.ts

@@ -2,29 +2,17 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { clientDocumentsGet } from "../funcs/clientDocumentsGet.js";
-import { clientDocumentsGetByFacets } from "../funcs/clientDocumentsGetByFacets.js";
-import { clientDocumentsGetPermissions } from "../funcs/clientDocumentsGetPermissions.js";
+import { clientDocumentsRetrieve } from "../funcs/clientDocumentsRetrieve.js";
+import { clientDocumentsRetrieveByFacets } from "../funcs/clientDocumentsRetrieveByFacets.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import { unwrapAsync } from "../types/fp.js";
+import { DocumentsPermissions } from "./documentspermissions.js";
 
 export class ClientDocuments extends ClientSDK {
-  /**
-   * Read document permissions
-   *
-   * @remarks
-   * Read the emails of all users who have access to the given document.
-   */
-  async getPermissions(
-    request: components.GetDocPermissionsRequest,
-    options?: RequestOptions,
-  ): Promise<components.GetDocPermissionsResponse> {
-    return unwrapAsync(clientDocumentsGetPermissions(
-      this,
-      request,
-      options,
-    ));
+  private _permissions?: DocumentsPermissions;
+  get permissions(): DocumentsPermissions {
+    return (this._permissions ??= new DocumentsPermissions(this._options));
   }
 
   /**
@@ -33,11 +21,11 @@ export class ClientDocuments extends ClientSDK {
    * @remarks
    * Read the documents including metadata (does not include enhanced metadata via `/documentmetadata`) for the given list of Glean Document IDs or URLs specified in the request.
    */
-  async get(
+  async retrieve(
     request?: components.GetDocumentsRequest | undefined,
     options?: RequestOptions,
   ): Promise<components.GetDocumentsResponse> {
-    return unwrapAsync(clientDocumentsGet(
+    return unwrapAsync(clientDocumentsRetrieve(
       this,
       request,
       options,
@@ -50,11 +38,11 @@ export class ClientDocuments extends ClientSDK {
    * @remarks
    * Read the documents including metadata (does not include enhanced metadata via `/documentmetadata`) macthing the given facet conditions.
    */
-  async getByFacets(
+  async retrieveByFacets(
     request?: components.GetDocumentsByFacetsRequest | undefined,
     options?: RequestOptions,
   ): Promise<components.GetDocumentsByFacetsResponse> {
-    return unwrapAsync(clientDocumentsGetByFacets(
+    return unwrapAsync(clientDocumentsRetrieveByFacets(
       this,
       request,
       options,

package/src/sdk/clientsearch.ts

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { clientSearchQuery } from "../funcs/clientSearchQuery.js";
+import { clientSearchRecommendations } from "../funcs/clientSearchRecommendations.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { Admin } from "./admin.js";
+import { Feed } from "./feed.js";
+
+export class ClientSearch extends ClientSDK {
+  private _admin?: Admin;
+  get admin(): Admin {
+    return (this._admin ??= new Admin(this._options));
+  }
+
+  private _feed?: Feed;
+  get feed(): Feed {
+    return (this._feed ??= new Feed(this._options));
+  }
+
+  /**
+   * Recommend documents
+   *
+   * @remarks
+   * Retrieve recommended documents for the given URL or Glean Document ID.
+   */
+  async recommendations(
+    request?: components.RecommendationsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<components.ResultsResponse | undefined> {
+    return unwrapAsync(clientSearchRecommendations(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Search
+   *
+   * @remarks
+   * Retrieve results from the index for the given query and filters.
+   */
+  async query(
+    request?: components.SearchRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<components.SearchResponse> {
+    return unwrapAsync(clientSearchQuery(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/clientshortcuts.ts

@@ -2,10 +2,9 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { clientShortcutsCreate } from "../funcs/clientShortcutsCreate.js";
 import { clientShortcutsDelete } from "../funcs/clientShortcutsDelete.js";
-import { clientShortcutsGet } from "../funcs/clientShortcutsGet.js";
 import { clientShortcutsList } from "../funcs/clientShortcutsList.js";
+import { clientShortcutsRetrieve } from "../funcs/clientShortcutsRetrieve.js";
 import { clientShortcutsUpdate } from "../funcs/clientShortcutsUpdate.js";
 import { clientShortcutsUpload } from "../funcs/clientShortcutsUpload.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -13,23 +12,6 @@ import * as components from "../models/components/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class ClientShortcuts extends ClientSDK {
-  /**
-   * Create shortcut
-   *
-   * @remarks
-   * Create a user-generated shortcut that contains an alias and destination URL.
-   */
-  async create(
-    request: components.CreateShortcutRequest,
-    options?: RequestOptions,
-  ): Promise<components.CreateShortcutResponse> {
-    return unwrapAsync(clientShortcutsCreate(
-      this,
-      request,
-      options,
-    ));
-  }
-
   /**
    * Delete shortcut
    *
@@ -53,11 +35,11 @@ export class ClientShortcuts extends ClientSDK {
    * @remarks
    * Read a particular shortcut's details given its ID.
    */
-  async get(
+  async retrieve(
     request: components.GetShortcutRequestUnion,
     options?: RequestOptions,
   ): Promise<components.GetShortcutResponse> {
-    return unwrapAsync(clientShortcutsGet(
+    return unwrapAsync(clientShortcutsRetrieve(
       this,
       request,
       options,

package/src/sdk/clientverification.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { clientVerificationAddReminder } from "../funcs/clientVerificationAddReminder.js";
+import { clientVerificationList } from "../funcs/clientVerificationList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class ClientVerification extends ClientSDK {
+  /**
+   * Create verification
+   *
+   * @remarks
+   * Creates a verification reminder for the document. Users can create verification reminders from different product surfaces.
+   */
+  async addReminder(
+    request: components.ReminderRequest,
+    options?: RequestOptions,
+  ): Promise<components.Verification> {
+    return unwrapAsync(clientVerificationAddReminder(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List verifications
+   *
+   * @remarks
+   * Returns the information to be rendered in verification dashboard. Includes information for each document owned by user regarding their verifications.
+   */
+  async list(
+    count?: number | undefined,
+    options?: RequestOptions,
+  ): Promise<components.VerificationFeed> {
+    return unwrapAsync(clientVerificationList(
+      this,
+      count,
+      options,
+    ));
+  }
+}

package/src/sdk/collections.ts

@@ -5,16 +5,20 @@
 import { clientCollectionsAddItems } from "../funcs/clientCollectionsAddItems.js";
 import { clientCollectionsCreate } from "../funcs/clientCollectionsCreate.js";
 import { clientCollectionsDelete } from "../funcs/clientCollectionsDelete.js";
-import { clientCollectionsDeleteItem } from "../funcs/clientCollectionsDeleteItem.js";
-import { clientCollectionsEditItem } from "../funcs/clientCollectionsEditItem.js";
-import { clientCollectionsGet } from "../funcs/clientCollectionsGet.js";
 import { clientCollectionsList } from "../funcs/clientCollectionsList.js";
+import { clientCollectionsRetrieve } from "../funcs/clientCollectionsRetrieve.js";
 import { clientCollectionsUpdate } from "../funcs/clientCollectionsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import { unwrapAsync } from "../types/fp.js";
+import { Item } from "./item.js";
 
 export class Collections extends ClientSDK {
+  private _item?: Item;
+  get item(): Item {
+    return (this._item ??= new Item(this._options));
+  }
+
   /**
    * Add Collection item
    *
@@ -66,23 +70,6 @@ export class Collections extends ClientSDK {
     ));
   }
 
-  /**
-   * Delete Collection item
-   *
-   * @remarks
-   * Delete a single item from a Collection.
-   */
-  async deleteItem(
-    request: components.DeleteCollectionItemRequest,
-    options?: RequestOptions,
-  ): Promise<components.DeleteCollectionItemResponse> {
-    return unwrapAsync(clientCollectionsDeleteItem(
-      this,
-      request,
-      options,
-    ));
-  }
-
   /**
    * Update Collection
    *
@@ -100,34 +87,17 @@ export class Collections extends ClientSDK {
     ));
   }
 
-  /**
-   * Update Collection item
-   *
-   * @remarks
-   * Update the URL, Glean Document ID, description of an item within a Collection given its ID.
-   */
-  async editItem(
-    request: components.EditCollectionItemRequest,
-    options?: RequestOptions,
-  ): Promise<components.EditCollectionItemResponse> {
-    return unwrapAsync(clientCollectionsEditItem(
-      this,
-      request,
-      options,
-    ));
-  }
-
   /**
    * Read Collection
    *
    * @remarks
    * Read the details of a Collection given its ID. Does not fetch items in this Collection.
    */
-  async get(
+  async retrieve(
     request: components.GetCollectionRequest,
     options?: RequestOptions,
   ): Promise<components.GetCollectionResponse> {
-    return unwrapAsync(clientCollectionsGet(
+    return unwrapAsync(clientCollectionsRetrieve(
       this,
       request,
       options,

package/src/sdk/config.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { indexingDatasourcesConfigRetrieve } from "../funcs/indexingDatasourcesConfigRetrieve.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Config extends ClientSDK {
+  /**
+   * Get datasource config
+   *
+   * @remarks
+   * Fetches the datasource config for the specified custom datasource.
+   */
+  async retrieve(
+    request: components.GetDatasourceConfigRequest,
+    options?: RequestOptions,
+  ): Promise<components.CustomDatasourceConfig> {
+    return unwrapAsync(indexingDatasourcesConfigRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/datasource.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { indexingTroubleshootingDatasourceStatus } from "../funcs/indexingTroubleshootingDatasourceStatus.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { DatasourceDocuments } from "./datasourcedocuments.js";
+import { Document } from "./document.js";
+import { User } from "./user.js";
+
+export class Datasource extends ClientSDK {
+  private _document?: Document;
+  get document(): Document {
+    return (this._document ??= new Document(this._options));
+  }
+
+  private _documents?: DatasourceDocuments;
+  get documents(): DatasourceDocuments {
+    return (this._documents ??= new DatasourceDocuments(this._options));
+  }
+
+  private _user?: User;
+  get user(): User {
+    return (this._user ??= new User(this._options));
+  }
+
+  /**
+   * Beta: Get datasource status
+   *
+   * @remarks
+   * Gather information about the datasource's overall status. 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 status(
+    datasource: string,
+    options?: RequestOptions,
+  ): Promise<components.DebugDatasourceStatusResponse> {
+    return unwrapAsync(indexingTroubleshootingDatasourceStatus(
+      this,
+      datasource,
+      options,
+    ));
+  }
+}

package/src/sdk/datasourcedocuments.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { indexingTroubleshootingDatasourceDocumentsDebug } from "../funcs/indexingTroubleshootingDatasourceDocumentsDebug.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class DatasourceDocuments extends ClientSDK {
+  /**
+   * Beta: Get information of a batch of documents
+   *
+   * @remarks
+   * Gives various information that would help in debugging related to a batch of documents. 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(
+    debugDocumentsRequest: components.DebugDocumentsRequest,
+    datasource: string,
+    options?: RequestOptions,
+  ): Promise<components.DebugDocumentsResponse> {
+    return unwrapAsync(indexingTroubleshootingDatasourceDocumentsDebug(
+      this,
+      debugDocumentsRequest,
+      datasource,
+      options,
+    ));
+  }
+}

package/src/sdk/datasources.ts

@@ -3,12 +3,17 @@
  */
 
 import { indexingDatasourcesAdd } from "../funcs/indexingDatasourcesAdd.js";
-import { indexingDatasourcesGetConfig } from "../funcs/indexingDatasourcesGetConfig.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import { unwrapAsync } from "../types/fp.js";
+import { Config } from "./config.js";
 
 export class Datasources extends ClientSDK {
+  private _config?: Config;
+  get config(): Config {
+    return (this._config ??= new Config(this._options));
+  }
+
   /**
    * Add or update datasource
    *
@@ -25,21 +30,4 @@ export class Datasources extends ClientSDK {
       options,
     ));
   }
-
-  /**
-   * Get datasource config
-   *
-   * @remarks
-   * Fetches the datasource config for the specified custom datasource.
-   */
-  async getConfig(
-    request: components.GetDatasourceConfigRequest,
-    options?: RequestOptions,
-  ): Promise<components.CustomDatasourceConfig> {
-    return unwrapAsync(indexingDatasourcesGetConfig(
-      this,
-      request,
-      options,
-    ));
-  }
 }

package/src/sdk/document.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { indexingTroubleshootingDatasourceDocumentDebug } from "../funcs/indexingTroubleshootingDatasourceDocumentDebug.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Document extends ClientSDK {
+  /**
+   * Beta: Get document information
+   *
+   * @remarks
+   * Gives various information that would help in debugging related to a particular document. 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(
+    debugDocumentRequest: components.DebugDocumentRequest,
+    datasource: string,
+    options?: RequestOptions,
+  ): Promise<components.DebugDocumentResponse> {
+    return unwrapAsync(indexingTroubleshootingDatasourceDocumentDebug(
+      this,
+      debugDocumentRequest,
+      datasource,
+      options,
+    ));
+  }
+}

package/src/sdk/documentspermissions.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { clientDocumentsPermissionsRetrieve } from "../funcs/clientDocumentsPermissionsRetrieve.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class DocumentsPermissions extends ClientSDK {
+  /**
+   * Read document permissions
+   *
+   * @remarks
+   * Read the emails of all users who have access to the given document.
+   */
+  async retrieve(
+    request: components.GetDocPermissionsRequest,
+    options?: RequestOptions,
+  ): Promise<components.GetDocPermissionsResponse> {
+    return unwrapAsync(clientDocumentsPermissionsRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/feed.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { clientSearchFeedRetrieve } from "../funcs/clientSearchFeedRetrieve.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Feed extends ClientSDK {
+  /**
+   * Feed of documents and events
+   *
+   * @remarks
+   * The personalized feed/home includes different types of contents including suggestions, recents, calendar events and many more.
+   */
+  async retrieve(
+    request: components.FeedRequest,
+    options?: RequestOptions,
+  ): Promise<components.FeedResponse> {
+    return unwrapAsync(clientSearchFeedRetrieve(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/files.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { clientChatFilesDelete } from "../funcs/clientChatFilesDelete.js";
+import { clientChatFilesRetrieve } from "../funcs/clientChatFilesRetrieve.js";
+import { clientChatFilesUpload } from "../funcs/clientChatFilesUpload.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Files extends ClientSDK {
+  /**
+   * Upload files for Chat.
+   *
+   * @remarks
+   * Upload files for Chat.
+   */
+  async upload(
+    uploadChatFilesRequest: components.UploadChatFilesRequest,
+    timezoneOffset?: number | undefined,
+    options?: RequestOptions,
+  ): Promise<components.UploadChatFilesResponse> {
+    return unwrapAsync(clientChatFilesUpload(
+      this,
+      uploadChatFilesRequest,
+      timezoneOffset,
+      options,
+    ));
+  }
+
+  /**
+   * Get files uploaded by a user for Chat.
+   *
+   * @remarks
+   * Get files uploaded by a user for Chat.
+   */
+  async retrieve(
+    getChatFilesRequest: components.GetChatFilesRequest,
+    timezoneOffset?: number | undefined,
+    options?: RequestOptions,
+  ): Promise<components.GetChatFilesResponse> {
+    return unwrapAsync(clientChatFilesRetrieve(
+      this,
+      getChatFilesRequest,
+      timezoneOffset,
+      options,
+    ));
+  }
+
+  /**
+   * Delete files uploaded by a user for chat.
+   *
+   * @remarks
+   * Delete files uploaded by a user for Chat.
+   */
+  async delete(
+    deleteChatFilesRequest: components.DeleteChatFilesRequest,
+    timezoneOffset?: number | undefined,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(clientChatFilesDelete(
+      this,
+      deleteChatFilesRequest,
+      timezoneOffset,
+      options,
+    ));
+  }
+}

package/src/sdk/indexing.ts

@@ -6,9 +6,9 @@ import { ClientSDK } from "../lib/sdks.js";
 import { Datasources } from "./datasources.js";
 import { IndexingAuthentication } from "./indexingauthentication.js";
 import { IndexingDocuments } from "./indexingdocuments.js";
+import { IndexingPeople } from "./indexingpeople.js";
+import { IndexingPermissions } from "./indexingpermissions.js";
 import { IndexingShortcuts } from "./indexingshortcuts.js";
-import { People } from "./people.js";
-import { Permissions } from "./permissions.js";
 import { Troubleshooting } from "./troubleshooting.js";
 
 export class Indexing extends ClientSDK {
@@ -17,9 +17,9 @@ export class Indexing extends ClientSDK {
     return (this._documents ??= new IndexingDocuments(this._options));
   }
 
-  private _permissions?: Permissions;
-  get permissions(): Permissions {
-    return (this._permissions ??= new Permissions(this._options));
+  private _permissions?: IndexingPermissions;
+  get permissions(): IndexingPermissions {
+    return (this._permissions ??= new IndexingPermissions(this._options));
   }
 
   private _troubleshooting?: Troubleshooting;
@@ -37,9 +37,9 @@ export class Indexing extends ClientSDK {
     return (this._authentication ??= new IndexingAuthentication(this._options));
   }
 
-  private _people?: People;
-  get people(): People {
-    return (this._people ??= new People(this._options));
+  private _people?: IndexingPeople;
+  get people(): IndexingPeople {
+    return (this._people ??= new IndexingPeople(this._options));
   }
 
   private _shortcuts?: IndexingShortcuts;