@gleanwork/api-client 0.10.3 → 0.11.0

package/docs/sdks/entities/README.md

@@ -14,6 +14,7 @@ List some set of details for all entities that fit the given criteria and return
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listentities" method="post" path="/rest/api/v1/listentities" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -41,7 +42,6 @@ async function run() {
     pageSize: 100,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -81,15 +81,12 @@ async function run() {
     ],
     pageSize: 100,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientEntitiesList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -137,6 +134,7 @@ Read people details for the given IDs.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="people" method="post" path="/rest/api/v1/people" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -152,7 +150,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -180,15 +177,12 @@ async function run() {
       "abc456",
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientEntitiesReadPeople failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/indexingauthentication/README.md

@@ -13,6 +13,7 @@ Rotates the secret value inside the Indexing API token and returns the new raw s
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/rotatetoken" method="post" path="/api/index/v1/rotatetoken" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -23,7 +24,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.indexing.authentication.rotateToken();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -46,15 +46,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await indexingAuthenticationRotateToken(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("indexingAuthenticationRotateToken failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/indexingdocuments/README.md

@@ -24,6 +24,7 @@ Adds a document to the index or updates an existing document.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/indexdocument" method="post" path="/api/index/v1/indexdocument" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -64,14 +65,12 @@ async function run() {
       datasource: "<value>",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingDocumentsAddOrUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -119,6 +118,7 @@ Adds or updates multiple documents in the index. Please refer to the [bulk index
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/indexdocuments" method="post" path="/api/index/v1/indexdocuments" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -157,14 +157,12 @@ async function run() {
     datasource: "<value>",
     documents: [],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingDocumentsIndex failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -212,6 +210,7 @@ Replaces the documents in a datasource using paginated batch API calls. Please r
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/bulkindexdocuments" method="post" path="/api/index/v1/bulkindexdocuments" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -252,14 +251,12 @@ async function run() {
     datasource: "<value>",
     documents: [],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingDocumentsBulkIndex failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -318,6 +315,7 @@ For more frequent document processing, contact Glean support.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/processalldocuments" method="post" path="/api/index/v1/processalldocuments" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -350,14 +348,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await indexingDocumentsProcessAll(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingDocumentsProcessAll failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -405,6 +401,7 @@ Deletes the specified document from the index. Succeeds if document is not prese
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/deletedocument" method="post" path="/api/index/v1/deletedocument" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -445,14 +442,12 @@ async function run() {
     objectType: "<value>",
     id: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingDocumentsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -503,6 +498,7 @@ Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexi
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/debug/{datasource}/document" method="post" path="/api/index/v1/debug/{datasource}/document" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -516,7 +512,6 @@ async function run() {
     docId: "art123",
   }, "<value>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -542,15 +537,12 @@ async function run() {
     objectType: "Article",
     docId: "art123",
   }, "<value>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("indexingDocumentsDebug failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -602,6 +594,7 @@ Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexi
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/debug/{datasource}/documents" method="post" path="/api/index/v1/debug/{datasource}/documents" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -619,7 +612,6 @@ async function run() {
     ],
   }, "<value>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -649,15 +641,12 @@ async function run() {
       },
     ],
   }, "<value>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("indexingDocumentsDebugMany failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -709,6 +698,7 @@ Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexi
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/checkdocumentaccess" method="post" path="/api/index/v1/checkdocumentaccess" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -724,7 +714,6 @@ async function run() {
     userEmail: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -752,15 +741,12 @@ async function run() {
     docId: "<id>",
     userEmail: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("indexingDocumentsCheckAccess failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -813,6 +799,7 @@ Tip: Use [/debug/{datasource}/document](https://developers.glean.com/indexing/de
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/getdocumentstatus" method="post" path="/api/index/v1/getdocumentstatus" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -827,7 +814,6 @@ async function run() {
     docId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -854,15 +840,12 @@ async function run() {
     objectType: "<value>",
     docId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("indexingDocumentsStatus failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -915,6 +898,7 @@ Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debu
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/getdocumentcount" method="post" path="/api/index/v1/getdocumentcount" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -927,7 +911,6 @@ async function run() {
     datasource: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -952,15 +935,12 @@ async function run() {
   const res = await indexingDocumentsCount(glean, {
     datasource: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("indexingDocumentsCount failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/indexingshortcuts/README.md

@@ -14,6 +14,7 @@ Replaces all the currently indexed shortcuts using paginated batch API calls. No
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/bulkindexshortcuts" method="post" path="/api/index/v1/bulkindexshortcuts" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -78,14 +79,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingShortcutsBulkIndex failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -133,6 +132,7 @@ Creates glean shortcuts for uploaded shortcuts info. Glean would host the shortc
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/uploadshortcuts" method="post" path="/api/index/v1/uploadshortcuts" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -203,14 +203,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingShortcutsUpload failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();

package/docs/sdks/insights/README.md

@@ -5,14 +5,15 @@
 
 ### Available Operations
 
-* [retrieve](#retrieve) - Read insights
+* [retrieve](#retrieve) - Get insights
 
 ## retrieve
 
-Reads the aggregate information for each user, query, and content.
+Gets the aggregate usage insights data displayed in the Insights Dashboards.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="insights" method="post" path="/rest/api/v1/insights" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -21,15 +22,8 @@ const glean = new Glean({
 });
 
 async function run() {
-  const result = await glean.client.insights.retrieve({
-    categories: [
-      "COLLECTIONS",
-      "SHORTCUTS",
-      "ANNOUNCEMENTS",
-    ],
-  });
-
-  // Handle the result
+  const result = await glean.client.insights.retrieve({});
+
   console.log(result);
 }
 
@@ -51,22 +45,13 @@ const glean = new GleanCore({
 });
 
 async function run() {
-  const res = await clientInsightsRetrieve(glean, {
-    categories: [
-      "COLLECTIONS",
-      "SHORTCUTS",
-      "ANNOUNCEMENTS",
-    ],
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await clientInsightsRetrieve(glean, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientInsightsRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/messages/README.md

@@ -13,6 +13,7 @@ Retrieves list of messages from messaging/chat datasources (e.g. Slack, Teams).
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="messages" method="post" path="/rest/api/v1/messages" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -26,7 +27,6 @@ async function run() {
     id: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -52,15 +52,12 @@ async function run() {
     idType: "CONVERSATION_ID",
     id: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientMessagesRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();