@gleanwork/api-client 0.10.3 → 0.11.0

package/docs/sdks/search/README.md

@@ -17,6 +17,7 @@ Retrieves results for search query without respect for permissions. This is avai
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="adminsearch" method="post" path="/rest/api/v1/adminsearch" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -58,7 +59,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -112,15 +112,12 @@ async function run() {
       facetBucketSize: 421489,
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientSearchQueryAsAdmin failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -169,6 +166,7 @@ Retrieve query suggestions, operators and documents for the given partially type
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="autocomplete" method="post" path="/rest/api/v1/autocomplete" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -184,7 +182,6 @@ async function run() {
     resultSize: 10,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -212,15 +209,12 @@ async function run() {
     datasource: "GDRIVE",
     resultSize: 10,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientSearchAutocomplete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -268,6 +262,7 @@ The personalized feed/home includes different types of contents including sugges
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="feed" method="post" path="/rest/api/v1/feed" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -280,7 +275,6 @@ async function run() {
     timeoutMillis: 5000,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -305,15 +299,12 @@ async function run() {
   const res = await clientSearchRetrieveFeed(glean, {
     timeoutMillis: 5000,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientSearchRetrieveFeed failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -361,6 +352,7 @@ Retrieve recommended documents for the given URL or Glean Document ID.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="recommendations" method="post" path="/rest/api/v1/recommendations" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -371,6 +363,54 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.search.recommendations({
     sourceDocument: {
+      containerDocument: {
+        metadata: {
+          datasource: "datasource",
+          objectType: "Feature Request",
+          container: "container",
+          parentId: "JIRA_EN-1337",
+          mimeType: "mimeType",
+          documentId: "documentId",
+          createTime: new Date("2000-01-23T04:56:07.000Z"),
+          updateTime: new Date("2000-01-23T04:56:07.000Z"),
+          author: {
+            name: "name",
+            obfuscatedId: "<id>",
+          },
+          components: [
+            "Backend",
+            "Networking",
+          ],
+          status: "[\"Done\"]",
+          customData: {
+            "someCustomField": {},
+          },
+        },
+      },
+      parentDocument: {
+        metadata: {
+          datasource: "datasource",
+          objectType: "Feature Request",
+          container: "container",
+          parentId: "JIRA_EN-1337",
+          mimeType: "mimeType",
+          documentId: "documentId",
+          createTime: new Date("2000-01-23T04:56:07.000Z"),
+          updateTime: new Date("2000-01-23T04:56:07.000Z"),
+          author: {
+            name: "name",
+            obfuscatedId: "<id>",
+          },
+          components: [
+            "Backend",
+            "Networking",
+          ],
+          status: "[\"Done\"]",
+          customData: {
+            "someCustomField": {},
+          },
+        },
+      },
       metadata: {
         datasource: "datasource",
         objectType: "Feature Request",
@@ -451,6 +491,54 @@ async function run() {
         },
       ],
       context: {
+        containerDocument: {
+          metadata: {
+            datasource: "datasource",
+            objectType: "Feature Request",
+            container: "container",
+            parentId: "JIRA_EN-1337",
+            mimeType: "mimeType",
+            documentId: "documentId",
+            createTime: new Date("2000-01-23T04:56:07.000Z"),
+            updateTime: new Date("2000-01-23T04:56:07.000Z"),
+            author: {
+              name: "name",
+              obfuscatedId: "<id>",
+            },
+            components: [
+              "Backend",
+              "Networking",
+            ],
+            status: "[\"Done\"]",
+            customData: {
+              "someCustomField": {},
+            },
+          },
+        },
+        parentDocument: {
+          metadata: {
+            datasource: "datasource",
+            objectType: "Feature Request",
+            container: "container",
+            parentId: "JIRA_EN-1337",
+            mimeType: "mimeType",
+            documentId: "documentId",
+            createTime: new Date("2000-01-23T04:56:07.000Z"),
+            updateTime: new Date("2000-01-23T04:56:07.000Z"),
+            author: {
+              name: "name",
+              obfuscatedId: "<id>",
+            },
+            components: [
+              "Backend",
+              "Networking",
+            ],
+            status: "[\"Done\"]",
+            customData: {
+              "someCustomField": {},
+            },
+          },
+        },
         metadata: {
           datasource: "datasource",
           objectType: "Feature Request",
@@ -477,7 +565,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -501,6 +588,54 @@ const glean = new GleanCore({
 async function run() {
   const res = await clientSearchRecommendations(glean, {
     sourceDocument: {
+      containerDocument: {
+        metadata: {
+          datasource: "datasource",
+          objectType: "Feature Request",
+          container: "container",
+          parentId: "JIRA_EN-1337",
+          mimeType: "mimeType",
+          documentId: "documentId",
+          createTime: new Date("2000-01-23T04:56:07.000Z"),
+          updateTime: new Date("2000-01-23T04:56:07.000Z"),
+          author: {
+            name: "name",
+            obfuscatedId: "<id>",
+          },
+          components: [
+            "Backend",
+            "Networking",
+          ],
+          status: "[\"Done\"]",
+          customData: {
+            "someCustomField": {},
+          },
+        },
+      },
+      parentDocument: {
+        metadata: {
+          datasource: "datasource",
+          objectType: "Feature Request",
+          container: "container",
+          parentId: "JIRA_EN-1337",
+          mimeType: "mimeType",
+          documentId: "documentId",
+          createTime: new Date("2000-01-23T04:56:07.000Z"),
+          updateTime: new Date("2000-01-23T04:56:07.000Z"),
+          author: {
+            name: "name",
+            obfuscatedId: "<id>",
+          },
+          components: [
+            "Backend",
+            "Networking",
+          ],
+          status: "[\"Done\"]",
+          customData: {
+            "someCustomField": {},
+          },
+        },
+      },
       metadata: {
         datasource: "datasource",
         objectType: "Feature Request",
@@ -581,6 +716,54 @@ async function run() {
         },
       ],
       context: {
+        containerDocument: {
+          metadata: {
+            datasource: "datasource",
+            objectType: "Feature Request",
+            container: "container",
+            parentId: "JIRA_EN-1337",
+            mimeType: "mimeType",
+            documentId: "documentId",
+            createTime: new Date("2000-01-23T04:56:07.000Z"),
+            updateTime: new Date("2000-01-23T04:56:07.000Z"),
+            author: {
+              name: "name",
+              obfuscatedId: "<id>",
+            },
+            components: [
+              "Backend",
+              "Networking",
+            ],
+            status: "[\"Done\"]",
+            customData: {
+              "someCustomField": {},
+            },
+          },
+        },
+        parentDocument: {
+          metadata: {
+            datasource: "datasource",
+            objectType: "Feature Request",
+            container: "container",
+            parentId: "JIRA_EN-1337",
+            mimeType: "mimeType",
+            documentId: "documentId",
+            createTime: new Date("2000-01-23T04:56:07.000Z"),
+            updateTime: new Date("2000-01-23T04:56:07.000Z"),
+            author: {
+              name: "name",
+              obfuscatedId: "<id>",
+            },
+            components: [
+              "Backend",
+              "Networking",
+            ],
+            status: "[\"Done\"]",
+            customData: {
+              "someCustomField": {},
+            },
+          },
+        },
         metadata: {
           datasource: "datasource",
           objectType: "Feature Request",
@@ -606,15 +789,12 @@ async function run() {
       },
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientSearchRecommendations failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -662,6 +842,7 @@ Retrieve results from the index for the given query and filters.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="search" method="post" path="/rest/api/v1/search" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -703,7 +884,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -757,15 +937,12 @@ async function run() {
       facetBucketSize: 400611,
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientSearchQuery failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/tools/README.md

@@ -14,6 +14,7 @@ Returns a filtered set of available tools based on optional tool name parameters
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="get_/rest/api/v1/tools/list" method="get" path="/rest/api/v1/tools/list" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -24,7 +25,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.tools.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -47,15 +47,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientToolsList(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientToolsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -114,6 +111,7 @@ Execute the specified tool with provided parameters
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/rest/api/v1/tools/call" method="post" path="/rest/api/v1/tools/call" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -132,7 +130,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -163,15 +160,12 @@ async function run() {
       },
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientToolsRun failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/verification/README.md

@@ -15,6 +15,7 @@ Creates a verification reminder for the document. Users can create verification
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="addverificationreminder" method="post" path="/rest/api/v1/addverificationreminder" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -27,7 +28,6 @@ async function run() {
     documentId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -52,15 +52,12 @@ async function run() {
   const res = await clientVerificationAddReminder(glean, {
     documentId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientVerificationAddReminder failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -108,6 +105,7 @@ Returns the information to be rendered in verification dashboard. Includes infor
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listverifications" method="post" path="/rest/api/v1/listverifications" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -118,7 +116,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.verification.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -141,15 +138,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientVerificationList(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientVerificationList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -197,6 +191,7 @@ Verify documents to keep the knowledge up to date within customer corpus.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="verify" method="post" path="/rest/api/v1/verify" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -209,7 +204,6 @@ async function run() {
     documentId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -234,15 +228,12 @@ async function run() {
   const res = await clientVerificationVerify(glean, {
     documentId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientVerificationVerify failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/visibilityoverrides/README.md

@@ -14,6 +14,7 @@ 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";
 
@@ -24,7 +25,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.documents.visibilityoverrides.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -47,15 +47,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDocumentsVisibilityoverridesList(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDocumentsVisibilityoverridesList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -114,6 +111,7 @@ Sets the visibility-override state of the documents specified, effectively hidin
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="setdocvisibility" method="post" path="/rest/api/v1/governance/documents/visibilityoverrides" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -124,7 +122,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.documents.visibilityoverrides.create({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -147,15 +144,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDocumentsVisibilityoverridesCreate(glean, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDocumentsVisibilityoverridesCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/examples/README.md

@@ -1,29 +1,31 @@
-# Examples
+# @gleanwork/api-client Examples
 
-## Run an example
+This directory contains example scripts demonstrating how to use the @gleanwork/api-client SDK.
 
-```bash
-# 1. cd into the root of the repo
-cd api-client-typescript 
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
 
-# 2. Install dependencies
-npm install
+## Setup
 
-# 3. Build the project
-npm run build
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
 
-# 4. cd into the examples directory
-cd examples/
+2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
 
-# 5. Fill in the .env file
-cp .env.example .env
+## Running the Examples
 
-# 6. Install dependencies
-npm install
+To run an example file from the examples directory:
 
-# 7. Run the script
-npm run script -- ./src/example.ts
+```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.