@gleanwork/api-client 0.10.3 → 0.11.0

package/docs/sdks/announcements/README.md

@@ -15,6 +15,7 @@ Create a textual announcement visible to some set of users based on department a
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createannouncement" method="post" path="/rest/api/v1/createannouncement" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 import { RFCDate } from "@gleanwork/api-client/types";
@@ -22054,7 +22055,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -44106,15 +44106,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientAnnouncementsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -44162,6 +44159,7 @@ Delete an existing user-generated announcement.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="deleteannouncement" method="post" path="/rest/api/v1/deleteannouncement" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -44198,14 +44196,12 @@ async function run() {
   const res = await clientAnnouncementsDelete(glean, {
     id: 458809,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("clientAnnouncementsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -44253,6 +44249,7 @@ Update a textual announcement visible to some set of users based on department a
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="updateannouncement" method="post" path="/rest/api/v1/updateannouncement" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 import { RFCDate } from "@gleanwork/api-client/types";
@@ -90878,7 +90875,6 @@ async function run() {
     id: 602589,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -137516,15 +137512,12 @@ async function run() {
     ],
     id: 602589,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientAnnouncementsUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/answers/README.md

@@ -17,6 +17,7 @@ Create a user-generated Answer that contains a question and answer.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createanswer" method="post" path="/rest/api/v1/createanswer" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 import { RFCDate } from "@gleanwork/api-client/types";
@@ -1361,7 +1362,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -2718,15 +2718,12 @@ async function run() {
       },
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientAnswersCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -2774,6 +2771,7 @@ Delete an existing user-generated Answer.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="deleteanswer" method="post" path="/rest/api/v1/deleteanswer" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -2812,14 +2810,12 @@ async function run() {
     id: 3,
     docId: "ANSWERS_answer_3",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("clientAnswersDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -2867,6 +2863,7 @@ Update an existing user-generated Answer.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="editanswer" method="post" path="/rest/api/v1/editanswer" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 import { RFCDate } from "@gleanwork/api-client/types";
@@ -3799,7 +3796,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -4744,15 +4740,12 @@ async function run() {
       text: "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientAnswersUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -4800,6 +4793,7 @@ Read the details of a particular Answer given its ID.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getanswer" method="post" path="/rest/api/v1/getanswer" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -4813,7 +4807,6 @@ async function run() {
     docId: "ANSWERS_answer_3",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -4839,15 +4832,12 @@ async function run() {
     id: 3,
     docId: "ANSWERS_answer_3",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientAnswersRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -4895,6 +4885,7 @@ List Answers created by the current user.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listanswers" method="post" path="/rest/api/v1/listanswers" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -4905,7 +4896,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.answers.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -4928,15 +4918,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientAnswersList(glean, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientAnswersList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

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();