@gleanwork/api-client 0.10.3 → 0.11.0

package/docs/sdks/people/README.md

@@ -25,6 +25,7 @@ Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/indexi
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/debug/{datasource}/user" method="post" path="/api/index/v1/debug/{datasource}/user" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -37,7 +38,6 @@ async function run() {
     email: "u1@foo.com",
   }, "<value>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -62,15 +62,12 @@ async function run() {
   const res = await indexingPeopleDebug(glean, {
     email: "u1@foo.com",
   }, "<value>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("indexingPeopleDebug failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -124,6 +121,7 @@ Tip: Use [/debug/{datasource}/status](https://developers.glean.com/indexing/debu
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/getusercount" method="post" path="/api/index/v1/getusercount" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -136,7 +134,6 @@ async function run() {
     datasource: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -161,15 +158,12 @@ async function run() {
   const res = await indexingPeopleCount(glean, {
     datasource: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("indexingPeopleCount failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -217,6 +211,7 @@ Adds an employee or updates information about an employee
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/indexemployee" method="post" path="/api/index/v1/indexemployee" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -271,14 +266,12 @@ async function run() {
       ],
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPeopleIndex failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -326,6 +319,7 @@ Replaces all the currently indexed employees using paginated batch API calls. Pl
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/bulkindexemployees" method="post" path="/api/index/v1/bulkindexemployees" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -426,14 +420,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPeopleBulkIndex failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -482,6 +474,7 @@ Schedules the immediate processing of employees and teams uploaded through the i
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/processallemployeesandteams" method="post" path="/api/index/v1/processallemployeesandteams" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -514,14 +507,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await indexingPeopleProcessAllEmployeesAndTeams(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPeopleProcessAllEmployeesAndTeams failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -568,6 +559,7 @@ Delete an employee. Silently succeeds if employee is not present.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/deleteemployee" method="post" path="/api/index/v1/deleteemployee" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -604,14 +596,12 @@ async function run() {
   const res = await indexingPeopleDelete(glean, {
     employeeEmail: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPeopleDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -659,6 +649,7 @@ Adds a team or updates information about a team
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/indexteam" method="post" path="/api/index/v1/indexteam" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -739,14 +730,12 @@ async function run() {
       ],
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPeopleIndexTeam failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -794,6 +783,7 @@ Delete a team based on provided id.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/deleteteam" method="post" path="/api/index/v1/deleteteam" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -830,14 +820,12 @@ async function run() {
   const res = await indexingPeopleDeleteTeam(glean, {
     id: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPeopleDeleteTeam failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -885,6 +873,7 @@ Replaces all the currently indexed teams using paginated batch API calls. Please
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/bulkindexteams" method="post" path="/api/index/v1/bulkindexteams" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -1015,14 +1004,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPeopleBulkIndexTeams failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();

package/docs/sdks/permissions/README.md

@@ -24,6 +24,7 @@ Updates the permissions for a given document without modifying document content.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/updatepermissions" method="post" path="/api/index/v1/updatepermissions" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -62,14 +63,12 @@ async function run() {
     datasource: "<value>",
     permissions: {},
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsUpdatePermissions failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -117,6 +116,7 @@ Adds a datasource user or updates an existing user.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/indexuser" method="post" path="/api/index/v1/indexuser" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -161,14 +161,12 @@ async function run() {
       name: "<value>",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsIndexUser failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -216,6 +214,7 @@ Replaces the users in a datasource using paginated batch API calls. Please refer
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/bulkindexusers" method="post" path="/api/index/v1/bulkindexusers" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -282,14 +281,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsBulkIndexUsers failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -337,6 +334,7 @@ Add or update a group in the datasource.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/indexgroup" method="post" path="/api/index/v1/indexgroup" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -379,14 +377,12 @@ async function run() {
       name: "<value>",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsIndexGroup failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -434,6 +430,7 @@ Replaces the groups in a datasource using paginated batch API calls. Please refe
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/bulkindexgroups" method="post" path="/api/index/v1/bulkindexgroups" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -488,14 +485,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsBulkIndexGroups failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -543,6 +538,7 @@ Add the memberships of a group in the datasource.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/indexmembership" method="post" path="/api/index/v1/indexmembership" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -585,14 +581,12 @@ async function run() {
       groupName: "<value>",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsIndexMembership failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -640,6 +634,7 @@ Replaces the memberships for a group in a datasource using paginated batch API c
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/bulkindexmemberships" method="post" path="/api/index/v1/bulkindexmemberships" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -688,14 +683,12 @@ async function run() {
       {},
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsBulkIndexMemberships failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -744,6 +737,7 @@ Schedules the immediate processing of all group memberships uploaded through the
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/processallmemberships" method="post" path="/api/index/v1/processallmemberships" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -776,14 +770,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await indexingPermissionsProcessMemberships(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsProcessMemberships failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -831,6 +823,7 @@ Delete the user from the datasource. Silently succeeds if user is not present.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/deleteuser" method="post" path="/api/index/v1/deleteuser" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -869,14 +862,12 @@ async function run() {
     datasource: "<value>",
     email: "Ed.Johnston@gmail.com",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsDeleteUser failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -924,6 +915,7 @@ Delete group from the datasource. Silently succeeds if group is not present.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/deletegroup" method="post" path="/api/index/v1/deletegroup" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -962,14 +954,12 @@ async function run() {
     datasource: "<value>",
     groupName: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsDeleteGroup failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -1017,6 +1007,7 @@ Delete membership to a group in the specified datasource. Silently succeeds if m
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/deletemembership" method="post" path="/api/index/v1/deletemembership" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -1059,14 +1050,12 @@ async function run() {
       groupName: "<value>",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsDeleteMembership failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -1114,6 +1103,7 @@ Allow the datasource be visible to the specified beta users. The default behavio
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="post_/api/index/v1/betausers" method="post" path="/api/index/v1/betausers" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -1160,14 +1150,12 @@ async function run() {
       "Shyanne_McLaughlin95@hotmail.com",
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("indexingPermissionsAuthorizeBetaUsers failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();