@gleanwork/api-client 0.13.1 → 0.13.3

package/docs/sdks/visibilityoverrides/README.md

@@ -1,192 +0,0 @@
-# Visibilityoverrides
-(*client.governance.documents.visibilityoverrides*)
-
-## Overview
-
-### Available Operations
-
-* [list](#list) - Fetches documents visibility
-* [create](#create) - Hide or unhide docs
-
-## list
-
-Fetches the visibility override status of the documents passed.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="getdocvisibility" method="get" path="/rest/api/v1/governance/documents/visibilityoverrides" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-
-async function run() {
-  const result = await glean.client.governance.documents.visibilityoverrides.list();
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { clientGovernanceDocumentsVisibilityoverridesList } from "@gleanwork/api-client/funcs/clientGovernanceDocumentsVisibilityoverridesList.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 clientGovernanceDocumentsVisibilityoverridesList(glean);
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("clientGovernanceDocumentsVisibilityoverridesList 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 {
-  // Query hooks for fetching data.
-  useClientGovernanceDocumentsVisibilityoverridesList,
-  useClientGovernanceDocumentsVisibilityoverridesListSuspense,
-
-  // Utility for prefetching data during server-side rendering and in React
-  // Server Components that will be immediately available to client components
-  // using the hooks.
-  prefetchClientGovernanceDocumentsVisibilityoverridesList,
-  
-  // Utilities to invalidate the query cache for this query in response to
-  // mutations and other user actions.
-  invalidateClientGovernanceDocumentsVisibilityoverridesList,
-  invalidateAllClientGovernanceDocumentsVisibilityoverridesList,
-} from "@gleanwork/api-client/react-query/clientGovernanceDocumentsVisibilityoverridesList.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `docIds`                                                                                                                                                                       | *string*[]                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                             | List of doc-ids which will have their hide status fetched.                                                                                                                     |
-| `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.GetDocumentVisibilityOverridesResponse](../../models/components/getdocumentvisibilityoverridesresponse.md)\>**
-
-### Errors
-
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-
-## create
-
-Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="setdocvisibility" method="post" path="/rest/api/v1/governance/documents/visibilityoverrides" -->
-```typescript
-import { Glean } from "@gleanwork/api-client";
-
-const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
-});
-
-async function run() {
-  const result = await glean.client.governance.documents.visibilityoverrides.create({});
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { clientGovernanceDocumentsVisibilityoverridesCreate } from "@gleanwork/api-client/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.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 clientGovernanceDocumentsVisibilityoverridesCreate(glean, {});
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("clientGovernanceDocumentsVisibilityoverridesCreate 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.
-  useClientGovernanceDocumentsVisibilityoverridesCreateMutation
-} from "@gleanwork/api-client/react-query/clientGovernanceDocumentsVisibilityoverridesCreate.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.UpdateDocumentVisibilityOverridesRequest](../../models/components/updatedocumentvisibilityoverridesrequest.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.UpdateDocumentVisibilityOverridesResponse](../../models/components/updatedocumentvisibilityoverridesresponse.md)\>**
-
-### Errors
-
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |

package/examples/README.md

@@ -1,31 +0,0 @@
-# @gleanwork/api-client Examples
-
-This directory contains example scripts demonstrating how to use the @gleanwork/api-client SDK.
-
-## Prerequisites
-
-- Node.js (v18 or higher)
-- npm
-
-## Setup
-
-1. Copy `.env.template` to `.env`:
-   ```bash
-   cp .env.template .env
-   ```
-
-2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
-
-## Running the Examples
-
-To run an example file from the examples directory:
-
-```bash
-npm run build && npx tsx example.ts
-```
-
-## Creating new examples
-
-Duplicate an existing example file, they won't be overwritten by the generation process.
-
-

package/src/__tests__/mockserver/README.md

@@ -1,52 +0,0 @@
-# Mock Server
-
-A generated HTTP mock server based on your OpenAPI Specification (OAS). Use this mock server for integration and contract testing.
-
-## Usage
-
-The server can be built and started via the [Go programming language toolchain](https://go.dev/) or [Docker](https://www.docker.com/).
-
-If you have Go installed, start the server directly via:
-
-```shell
-go run .
-```
-
-Otherwise, if you have Docker installed, build and run the server via:
-
-```shell
-docker build -t mockserver .
-docker run -i -p 18080:18080 -t --rm mockserver
-```
-
-By default, the server runs on port `18080`.
-
-### Server Paths
-
-The server contains generated paths from the OAS and the following additional built-in paths.
-
-| Path | Description |
-|---|---|
-| [`/_mockserver/health`](https://localhost:18080/_mockserver/health) | verify server is running |
-| [`/_mockserver/log`](https://localhost:18080/_mockserver/log) | view per-OAS-operation logs |
-
-Any request outside the generated and built-in paths will return a `404 Not Found` response.
-
-### Server Customization
-
-The server supports the following flags for customization.
-
-| Flag | Default | Description |
-|---|---|---|
-| `-address` | `:18080` | server listen address |
-| `-log-format` | `text` | logging format (supported: `JSON`, `text`) |
-| `-log-level` | `INFO` | logging level (supported: `DEBUG`, `INFO`, `WARN`, `ERROR`) |
-
-For example, enabling server debug logging:
-
-```shell
-# via `go run`
-go run . -log-level=DEBUG
-# via `docker run`
-docker run -i -p 18080:18080 -t --rm mockserver -log-level=DEBUG
-```