npm - @gleanwork/api-client - Versions diffs - 0.13.2 → 0.13.4 - Mend

@gleanwork/api-client 0.13.2 → 0.13.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4267) hide show

package/docs/sdks/indexingdocuments/README.md DELETED Viewed

@@ -1,983 +0,0 @@
-# IndexingDocuments
-(*indexing.documents*)
-## Overview
-### Available Operations
-* [addOrUpdate](#addorupdate) - Index document
-* [index](#index) - Index documents
-* [bulkIndex](#bulkindex) - Bulk index documents
-* [processAll](#processall) - Schedules the processing of uploaded documents
-* [delete](#delete) - Delete document
-* [debug](#debug) - Beta: Get document information
-* [debugMany](#debugmany) - Beta: Get information of a batch of documents
-* [checkAccess](#checkaccess) - Check document access
-* [~~status~~](#status) - Get document upload and indexing status :warning: **Deprecated**
-* [~~count~~](#count) - Get document count :warning: **Deprecated**
-## addOrUpdate
-Adds a document to the index or updates an existing document.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/indexdocument" method="post" path="/api/index/v1/indexdocument" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  await glean.indexing.documents.addOrUpdate({
-    document: {
-      datasource: "<value>",
-    },
-  });
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingDocumentsAddOrUpdate } from "@gleanwork/api-client/funcs/indexingDocumentsAddOrUpdate.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const res = await indexingDocumentsAddOrUpdate(glean, {
-    document: {
-      datasource: "<value>",
-    },
-  });
-  if (res.ok) {
-    const { value: result } = res;
-  } else {
-    console.log("indexingDocumentsAddOrUpdate failed:", res.error);
-  }
-}
-run();
-```
-### React hooks and utilities
-This method can be used in React components through the following hooks and
-associated utilities.
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-[hook-guide]: ../../../REACT_QUERY.md
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useIndexingDocumentsAddOrUpdateMutation
-} from "@gleanwork/api-client/react-query/indexingDocumentsAddOrUpdate.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.IndexDocumentRequest](../../models/components/indexdocumentrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-### Response
-**Promise\<void\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-## index
-Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-indexing/choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/indexdocuments" method="post" path="/api/index/v1/indexdocuments" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  await glean.indexing.documents.index({
-    datasource: "<value>",
-    documents: [],
-  });
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingDocumentsIndex } from "@gleanwork/api-client/funcs/indexingDocumentsIndex.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const res = await indexingDocumentsIndex(glean, {
-    datasource: "<value>",
-    documents: [],
-  });
-  if (res.ok) {
-    const { value: result } = res;
-  } else {
-    console.log("indexingDocumentsIndex failed:", res.error);
-  }
-}
-run();
-```
-### React hooks and utilities
-This method can be used in React components through the following hooks and
-associated utilities.
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-[hook-guide]: ../../../REACT_QUERY.md
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useIndexingDocumentsIndexMutation
-} from "@gleanwork/api-client/react-query/indexingDocumentsIndex.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.IndexDocumentsRequest](../../models/components/indexdocumentsrequest.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-### Response
-**Promise\<void\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-## bulkIndex
-Replaces the documents in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/bulkindexdocuments" method="post" path="/api/index/v1/bulkindexdocuments" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  await glean.indexing.documents.bulkIndex({
-    uploadId: "<id>",
-    datasource: "<value>",
-    documents: [],
-  });
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingDocumentsBulkIndex } from "@gleanwork/api-client/funcs/indexingDocumentsBulkIndex.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const res = await indexingDocumentsBulkIndex(glean, {
-    uploadId: "<id>",
-    datasource: "<value>",
-    documents: [],
-  });
-  if (res.ok) {
-    const { value: result } = res;
-  } else {
-    console.log("indexingDocumentsBulkIndex failed:", res.error);
-  }
-}
-run();
-```
-### React hooks and utilities
-This method can be used in React components through the following hooks and
-associated utilities.
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-[hook-guide]: ../../../REACT_QUERY.md
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useIndexingDocumentsBulkIndexMutation
-} from "@gleanwork/api-client/react-query/indexingDocumentsBulkIndex.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.BulkIndexDocumentsRequest](../../models/components/bulkindexdocumentsrequest.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-### Response
-**Promise\<void\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-## processAll
-Schedules the immediate processing of documents uploaded through the indexing API. By default the uploaded documents will be processed asynchronously but this API can be used to schedule processing of all documents on demand.
-If a `datasource` parameter is specified, processing is limited to that custom datasource. Without it, processing applies to all documents across all custom datasources.
-#### Rate Limits
-This endpoint is rate-limited to one usage every 3 hours. Exceeding this limit results in a 429 response code. Here's how the rate limit works:
-1. Calling `/processalldocuments` for datasource `foo` prevents another call for `foo` for 3 hours.
-2. Calling `/processalldocuments` for datasource `foo` doesn't affect immediate calls for `bar`.
-3. Calling `/processalldocuments` for all datasources prevents any datasource calls for 3 hours.
-4. Calling `/processalldocuments` for datasource `foo` doesn't affect immediate calls for all datasources.
-For more frequent document processing, contact Glean support.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/processalldocuments" method="post" path="/api/index/v1/processalldocuments" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  await glean.indexing.documents.processAll();
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingDocumentsProcessAll } from "@gleanwork/api-client/funcs/indexingDocumentsProcessAll.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const res = await indexingDocumentsProcessAll(glean);
-  if (res.ok) {
-    const { value: result } = res;
-  } else {
-    console.log("indexingDocumentsProcessAll failed:", res.error);
-  }
-}
-run();
-```
-### React hooks and utilities
-This method can be used in React components through the following hooks and
-associated utilities.
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-[hook-guide]: ../../../REACT_QUERY.md
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useIndexingDocumentsProcessAllMutation
-} from "@gleanwork/api-client/react-query/indexingDocumentsProcessAll.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.ProcessAllDocumentsRequest](../../models/components/processalldocumentsrequest.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-### Response
-**Promise\<void\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-## delete
-Deletes the specified document from the index. Succeeds if document is not present.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/deletedocument" method="post" path="/api/index/v1/deletedocument" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  await glean.indexing.documents.delete({
-    datasource: "<value>",
-    objectType: "<value>",
-    id: "<id>",
-  });
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingDocumentsDelete } from "@gleanwork/api-client/funcs/indexingDocumentsDelete.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const res = await indexingDocumentsDelete(glean, {
-    datasource: "<value>",
-    objectType: "<value>",
-    id: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-  } else {
-    console.log("indexingDocumentsDelete failed:", res.error);
-  }
-}
-run();
-```
-### React hooks and utilities
-This method can be used in React components through the following hooks and
-associated utilities.
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-[hook-guide]: ../../../REACT_QUERY.md
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useIndexingDocumentsDeleteMutation
-} from "@gleanwork/api-client/react-query/indexingDocumentsDelete.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.DeleteDocumentRequest](../../models/components/deletedocumentrequest.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-### Response
-**Promise\<void\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-## debug
-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/indexing/debugging/datasource-config) for more information.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/debug/{datasource}/document" method="post" path="/api/index/v1/debug/{datasource}/document" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const result = await glean.indexing.documents.debug({
-    objectType: "Article",
-    docId: "art123",
-  }, "<value>");
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingDocumentsDebug } from "@gleanwork/api-client/funcs/indexingDocumentsDebug.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const res = await indexingDocumentsDebug(glean, {
-    objectType: "Article",
-    docId: "art123",
-  }, "<value>");
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("indexingDocumentsDebug failed:", res.error);
-  }
-}
-run();
-```
-### React hooks and utilities
-This method can be used in React components through the following hooks and
-associated utilities.
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-[hook-guide]: ../../../REACT_QUERY.md
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useIndexingDocumentsDebugMutation
-} from "@gleanwork/api-client/react-query/indexingDocumentsDebug.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `datasource`                                                                                                                                                                   | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The datasource to which the document belongs                                                                                                                                   |
-| `debugDocumentRequest`                                                                                                                                                         | [components.DebugDocumentRequest](../../models/components/debugdocumentrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-### Response
-**Promise\<[components.DebugDocumentResponse](../../models/components/debugdocumentresponse.md)\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-## debugMany
-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/indexing/debugging/datasource-config) for more information.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/debug/{datasource}/documents" method="post" path="/api/index/v1/debug/{datasource}/documents" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const result = await glean.indexing.documents.debugMany({
-    debugDocuments: [
-      {
-        objectType: "Article",
-        docId: "art123",
-      },
-    ],
-  }, "<value>");
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingDocumentsDebugMany } from "@gleanwork/api-client/funcs/indexingDocumentsDebugMany.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const res = await indexingDocumentsDebugMany(glean, {
-    debugDocuments: [
-      {
-        objectType: "Article",
-        docId: "art123",
-      },
-    ],
-  }, "<value>");
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("indexingDocumentsDebugMany failed:", res.error);
-  }
-}
-run();
-```
-### React hooks and utilities
-This method can be used in React components through the following hooks and
-associated utilities.
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-[hook-guide]: ../../../REACT_QUERY.md
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useIndexingDocumentsDebugManyMutation
-} from "@gleanwork/api-client/react-query/indexingDocumentsDebugMany.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `datasource`                                                                                                                                                                   | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The datasource to which the document belongs                                                                                                                                   |
-| `debugDocumentsRequest`                                                                                                                                                        | [components.DebugDocumentsRequest](../../models/components/debugdocumentsrequest.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-### Response
-**Promise\<[components.DebugDocumentsResponse](../../models/components/debugdocumentsresponse.md)\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-## checkAccess
-Check if a given user has access to access a document in a custom datasource
-Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexing/debugging/datasource-config) for more information.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/checkdocumentaccess" method="post" path="/api/index/v1/checkdocumentaccess" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const result = await glean.indexing.documents.checkAccess({
-    datasource: "<value>",
-    objectType: "<value>",
-    docId: "<id>",
-    userEmail: "<value>",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingDocumentsCheckAccess } from "@gleanwork/api-client/funcs/indexingDocumentsCheckAccess.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const res = await indexingDocumentsCheckAccess(glean, {
-    datasource: "<value>",
-    objectType: "<value>",
-    docId: "<id>",
-    userEmail: "<value>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("indexingDocumentsCheckAccess failed:", res.error);
-  }
-}
-run();
-```
-### React hooks and utilities
-This method can be used in React components through the following hooks and
-associated utilities.
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-[hook-guide]: ../../../REACT_QUERY.md
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useIndexingDocumentsCheckAccessMutation
-} from "@gleanwork/api-client/react-query/indexingDocumentsCheckAccess.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.CheckDocumentAccessRequest](../../models/components/checkdocumentaccessrequest.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-### Response
-**Promise\<[components.CheckDocumentAccessResponse](../../models/components/checkdocumentaccessresponse.md)\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-## ~~status~~
-Intended for debugging/validation. Fetches the current upload and indexing status of documents.
-Tip: Use [/debug/{datasource}/document](https://developers.glean.com/indexing/debugging/datasource-document) for richer information.
-> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/getdocumentstatus" method="post" path="/api/index/v1/getdocumentstatus" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const result = await glean.indexing.documents.status({
-    datasource: "<value>",
-    objectType: "<value>",
-    docId: "<id>",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingDocumentsStatus } from "@gleanwork/api-client/funcs/indexingDocumentsStatus.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const res = await indexingDocumentsStatus(glean, {
-    datasource: "<value>",
-    objectType: "<value>",
-    docId: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("indexingDocumentsStatus failed:", res.error);
-  }
-}
-run();
-```
-### React hooks and utilities
-This method can be used in React components through the following hooks and
-associated utilities.
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-[hook-guide]: ../../../REACT_QUERY.md
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useIndexingDocumentsStatusMutation
-} from "@gleanwork/api-client/react-query/indexingDocumentsStatus.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.GetDocumentStatusRequest](../../models/components/getdocumentstatusrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-### Response
-**Promise\<[components.GetDocumentStatusResponse](../../models/components/getdocumentstatusresponse.md)\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-## ~~count~~
-Fetches document count for the specified custom datasource.
-Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debugging/datasource-status) for richer information.
-> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/getdocumentcount" method="post" path="/api/index/v1/getdocumentcount" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const result = await glean.indexing.documents.count({
-    datasource: "<value>",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingDocumentsCount } from "@gleanwork/api-client/funcs/indexingDocumentsCount.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-async function run() {
-  const res = await indexingDocumentsCount(glean, {
-    datasource: "<value>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("indexingDocumentsCount failed:", res.error);
-  }
-}
-run();
-```
-### React hooks and utilities
-This method can be used in React components through the following hooks and
-associated utilities.
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-[hook-guide]: ../../../REACT_QUERY.md
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useIndexingDocumentsCountMutation
-} from "@gleanwork/api-client/react-query/indexingDocumentsCount.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.GetDocumentCountRequest](../../models/components/getdocumentcountrequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-### Response
-**Promise\<[components.GetDocumentCountResponse](../../models/components/getdocumentcountresponse.md)\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |