npm - @gleanwork/api-client - Versions diffs - 0.1.0-beta.9 → 0.2.0 - Mend

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

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 (1266) hide show

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

@@ -1,110 +0,0 @@
-# Troubleshooting
-(*indexing.troubleshooting*)
-## Overview
-### Available Operations
-* [checkAccess](#checkaccess) - Check document access
-## 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/docs/indexing_api/indexing_api_troubleshooting/) for more information.
-### Example Usage
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-async function run() {
-  const result = await glean.indexing.troubleshooting.checkAccess({
-    datasource: "<value>",
-    objectType: "<value>",
-    docId: "<id>",
-    userEmail: "<value>",
-  });
-  // Handle the result
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingTroubleshootingCheckAccess } from "@gleanwork/api-client/funcs/indexingTroubleshootingCheckAccess.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-async function run() {
-  const res = await indexingTroubleshootingCheckAccess(glean, {
-    datasource: "<value>",
-    objectType: "<value>",
-    docId: "<id>",
-    userEmail: "<value>",
-  });
-  if (!res.ok) {
-    throw res.error;
-  }
-  const { value: result } = res;
-  // Handle the result
-  console.log(result);
-}
-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.
-  useIndexingTroubleshootingCheckAccessMutation
-} from "@gleanwork/api-client/react-query/indexingTroubleshootingCheckAccess.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          | \*/\*             |

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

@@ -1,209 +0,0 @@
-# TroubleshootingDocuments
-(*indexing.troubleshooting.documents*)
-## Overview
-### Available Operations
-* [~~status~~](#status) - Get document upload and indexing status :warning: **Deprecated**
-* [~~count~~](#count) - Get document count :warning: **Deprecated**
-## ~~status~~
-Intended for debugging/validation. Fetches the current upload and indexing status of documents.
-Tip: Use [/debug/{datasource}/document](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-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
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-async function run() {
-  const result = await glean.indexing.troubleshooting.documents.status({
-    datasource: "<value>",
-    objectType: "<value>",
-    docId: "<id>",
-  });
-  // Handle the result
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingTroubleshootingDocumentsStatus } from "@gleanwork/api-client/funcs/indexingTroubleshootingDocumentsStatus.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-async function run() {
-  const res = await indexingTroubleshootingDocumentsStatus(glean, {
-    datasource: "<value>",
-    objectType: "<value>",
-    docId: "<id>",
-  });
-  if (!res.ok) {
-    throw res.error;
-  }
-  const { value: result } = res;
-  // Handle the result
-  console.log(result);
-}
-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.
-  useIndexingTroubleshootingDocumentsStatusMutation
-} from "@gleanwork/api-client/react-query/indexingTroubleshootingDocumentsStatus.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/docs/indexing_api/indexing_api_troubleshooting/#debug-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
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-async function run() {
-  const result = await glean.indexing.troubleshooting.documents.count({
-    datasource: "<value>",
-  });
-  // Handle the result
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingTroubleshootingDocumentsCount } from "@gleanwork/api-client/funcs/indexingTroubleshootingDocumentsCount.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-async function run() {
-  const res = await indexingTroubleshootingDocumentsCount(glean, {
-    datasource: "<value>",
-  });
-  if (!res.ok) {
-    throw res.error;
-  }
-  const { value: result } = res;
-  // Handle the result
-  console.log(result);
-}
-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.
-  useIndexingTroubleshootingDocumentsCountMutation
-} from "@gleanwork/api-client/react-query/indexingTroubleshootingDocumentsCount.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          | \*/\*             |

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

@@ -1,106 +0,0 @@
-# User
-(*indexing.troubleshooting.datasource.user*)
-## Overview
-### Available Operations
-* [debug](#debug) - Beta: Get user information
-## debug
-Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice.
-Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information.
-### Example Usage
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-async function run() {
-  const result = await glean.indexing.troubleshooting.datasource.user.debug({
-    email: "u1@foo.com",
-  }, "<value>");
-  // Handle the result
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingTroubleshootingDatasourceUserDebug } from "@gleanwork/api-client/funcs/indexingTroubleshootingDatasourceUserDebug.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-async function run() {
-  const res = await indexingTroubleshootingDatasourceUserDebug(glean, {
-    email: "u1@foo.com",
-  }, "<value>");
-  if (!res.ok) {
-    throw res.error;
-  }
-  const { value: result } = res;
-  // Handle the result
-  console.log(result);
-}
-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.
-  useIndexingTroubleshootingDatasourceUserDebugMutation
-} from "@gleanwork/api-client/react-query/indexingTroubleshootingDatasourceUserDebug.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `datasource`                                                                                                                                                                   | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The datasource to which the user belongs                                                                                                                                       |
-| `debugUserRequest`                                                                                                                                                             | [components.DebugUserRequest](../../models/components/debuguserrequest.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.DebugUserResponse](../../models/components/debuguserresponse.md)\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |

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

@@ -1,106 +0,0 @@
-# Users
-(*indexing.troubleshooting.users*)
-## Overview
-### Available Operations
-* [~~count~~](#count) - Get user count :warning: **Deprecated**
-## ~~count~~
-Fetches user count for the specified custom datasource.
-Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information.
-> :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible.
-### Example Usage
-```typescript
-import { Glean } from "@gleanwork/api-client";
-const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-async function run() {
-  const result = await glean.indexing.troubleshooting.users.count({
-    datasource: "<value>",
-  });
-  // Handle the result
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { indexingTroubleshootingUsersCount } from "@gleanwork/api-client/funcs/indexingTroubleshootingUsersCount.js";
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-async function run() {
-  const res = await indexingTroubleshootingUsersCount(glean, {
-    datasource: "<value>",
-  });
-  if (!res.ok) {
-    throw res.error;
-  }
-  const { value: result } = res;
-  // Handle the result
-  console.log(result);
-}
-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.
-  useIndexingTroubleshootingUsersCountMutation
-} from "@gleanwork/api-client/react-query/indexingTroubleshootingUsersCount.js";
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.GetUserCountRequest](../../models/components/getusercountrequest.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.GetUserCountResponse](../../models/components/getusercountresponse.md)\>**
-### Errors
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |