@gleanwork/api-client 0.10.5 → 0.11.0

package/docs/sdks/chat/README.md

@@ -22,6 +22,7 @@ Have a conversation with Glean AI.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="chat" method="post" path="/rest/api/v1/chat" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -42,7 +43,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -75,15 +75,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientChatCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -132,6 +129,7 @@ Deletes all saved Chats a user has had and all their contained conversational co
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="deleteallchats" method="post" path="/rest/api/v1/deleteallchats" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -164,14 +162,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientChatDeleteAll(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("clientChatDeleteAll failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -219,6 +215,7 @@ Deletes saved Chats and all their contained conversational content.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="deletechats" method="post" path="/rest/api/v1/deletechats" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -255,14 +252,12 @@ async function run() {
   const res = await clientChatDelete(glean, {
     ids: [],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("clientChatDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -311,6 +306,7 @@ Retrieves the chat history between Glean Assistant and the user for a given Chat
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getchat" method="post" path="/rest/api/v1/getchat" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -323,7 +319,6 @@ async function run() {
     id: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -348,15 +343,12 @@ async function run() {
   const res = await clientChatRetrieve(glean, {
     id: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientChatRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -405,6 +397,7 @@ Retrieves all the saved Chats between Glean Assistant and the user. The returned
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listchats" method="post" path="/rest/api/v1/listchats" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -415,7 +408,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.chat.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -438,15 +430,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientChatList(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientChatList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -494,6 +483,7 @@ Gets the Chat application details for the specified application ID.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getchatapplication" method="post" path="/rest/api/v1/getchatapplication" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -506,7 +496,6 @@ async function run() {
     id: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -531,15 +520,12 @@ async function run() {
   const res = await clientChatRetrieveApplication(glean, {
     id: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientChatRetrieveApplication failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -588,6 +574,7 @@ Upload files for Chat.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="uploadchatfiles" method="post" path="/rest/api/v1/uploadchatfiles" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 import { openAsBlob } from "node:fs";
@@ -599,14 +586,10 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.chat.uploadFiles({
     files: [
-      {
-        fileName: "example.file",
-        content: await openAsBlob("example.file"),
-      },
+      await openAsBlob("example.file"),
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -631,21 +614,15 @@ const glean = new GleanCore({
 async function run() {
   const res = await clientChatUploadFiles(glean, {
     files: [
-      {
-        fileName: "example.file",
-        content: await openAsBlob("example.file"),
-      },
+      await openAsBlob("example.file"),
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientChatUploadFiles failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -694,6 +671,7 @@ Get files uploaded by a user for Chat.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getchatfiles" method="post" path="/rest/api/v1/getchatfiles" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -708,7 +686,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -735,15 +712,12 @@ async function run() {
       "<value 1>",
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientChatRetrieveFiles failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -792,6 +766,7 @@ Delete files uploaded by a user for Chat.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="deletechatfiles" method="post" path="/rest/api/v1/deletechatfiles" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -836,14 +811,12 @@ async function run() {
       "<value 3>",
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("clientChatDeleteFiles failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -892,6 +865,7 @@ Have a conversation with Glean AI.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="chatStream" method="post" path="/rest/api/v1/chat#stream" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -912,7 +886,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -945,15 +918,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientChatCreateStream failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/clientauthentication/README.md

@@ -18,6 +18,7 @@ for use with the Client API (e.g. `/rest/api/v1/*`).
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createauthtoken" method="post" path="/rest/api/v1/createauthtoken" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -28,7 +29,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.authentication.createToken();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -51,15 +51,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientAuthenticationCreateToken(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientAuthenticationCreateToken failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/clientdocuments/README.md

@@ -16,6 +16,7 @@ Read the emails of all users who have access to the given document.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getdocpermissions" method="post" path="/rest/api/v1/getdocpermissions" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -26,7 +27,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.documents.retrievePermissions({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -49,15 +49,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientDocumentsRetrievePermissions(glean, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientDocumentsRetrievePermissions failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -105,6 +102,7 @@ Read the documents including metadata (does not include enhanced metadata via `/
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getdocuments" method="post" path="/rest/api/v1/getdocuments" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -115,7 +113,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.documents.retrieve();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -138,15 +135,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientDocumentsRetrieve(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientDocumentsRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -194,6 +188,7 @@ Read the documents including metadata (does not include enhanced metadata via `/
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getdocumentsbyfacets" method="post" path="/rest/api/v1/getdocumentsbyfacets" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -241,7 +236,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -301,15 +295,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientDocumentsRetrieveByFacets failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -357,6 +348,7 @@ Generate an AI summary of the requested documents.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="summarize" method="post" path="/rest/api/v1/summarize" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -381,7 +373,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -418,15 +409,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientDocumentsSummarize failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/clientshortcuts/README.md

@@ -17,6 +17,7 @@ Create a user-generated shortcut that contains an alias and destination URL.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createshortcut" method="post" path="/rest/api/v1/createshortcut" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 import { RFCDate } from "@gleanwork/api-client/types";
@@ -1613,7 +1614,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -3222,15 +3222,12 @@ async function run() {
       ],
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientShortcutsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -3278,6 +3275,7 @@ Delete an existing user-generated shortcut.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="deleteshortcut" method="post" path="/rest/api/v1/deleteshortcut" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -3314,14 +3312,12 @@ async function run() {
   const res = await clientShortcutsDelete(glean, {
     id: 975862,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("clientShortcutsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -3369,6 +3365,7 @@ Read a particular shortcut's details given its ID.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getshortcut" method="post" path="/rest/api/v1/getshortcut" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -3381,7 +3378,6 @@ async function run() {
     alias: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -3406,15 +3402,12 @@ async function run() {
   const res = await clientShortcutsRetrieve(glean, {
     alias: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientShortcutsRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -3462,6 +3455,7 @@ List shortcuts editable/owned by the currently authenticated user.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listshortcuts" method="post" path="/rest/api/v1/listshortcuts" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -3489,7 +3483,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -3529,15 +3522,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientShortcutsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -3585,6 +3575,7 @@ Updates the shortcut with the given ID.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="updateshortcut" method="post" path="/rest/api/v1/updateshortcut" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 import { RFCDate } from "@gleanwork/api-client/types";
@@ -6437,7 +6428,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -9302,15 +9292,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientShortcutsUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();