@gleanwork/api-client 0.10.5 → 0.11.0

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

package/docs/sdks/pins/README.md

@@ -17,6 +17,7 @@ Update an existing user-generated pin.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="editpin" method="post" path="/rest/api/v1/editpin" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -43,7 +44,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -82,15 +82,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientPinsUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -138,6 +135,7 @@ Read pin details given its ID.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getpin" method="post" path="/rest/api/v1/getpin" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -148,7 +146,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.pins.retrieve({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -171,15 +168,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientPinsRetrieve(glean, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientPinsRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -227,6 +221,7 @@ Lists all pins.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listpins" method="post" path="/rest/api/v1/listpins" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -237,7 +232,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.pins.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -260,15 +254,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientPinsList(glean, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientPinsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -316,6 +307,7 @@ Pin a document as a result for a given search query.Pin results that are known t
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pin" method="post" path="/rest/api/v1/pin" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -342,7 +334,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -381,15 +372,12 @@ async function run() {
       },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientPinsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -437,6 +425,7 @@ Unpin a previously pinned result.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="unpin" method="post" path="/rest/api/v1/unpin" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -469,14 +458,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientPinsRemove(glean, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("clientPinsRemove failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();

package/docs/sdks/policies/README.md

@@ -17,6 +17,7 @@ Fetches the specified policy version, or the latest if no version is provided.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getpolicy" method="get" path="/rest/api/v1/governance/data/policies/{id}" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -27,7 +28,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.data.policies.retrieve("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,15 +50,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDataPoliciesRetrieve(glean, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDataPoliciesRetrieve failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -118,6 +115,7 @@ Updates an existing policy.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="updatepolicy" method="post" path="/rest/api/v1/governance/data/policies/{id}" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -128,7 +126,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.data.policies.update({}, "<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -151,15 +148,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDataPoliciesUpdate(glean, {}, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDataPoliciesUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -208,6 +202,7 @@ Lists policies with filtering.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listpolicies" method="get" path="/rest/api/v1/governance/data/policies" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -218,7 +213,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.data.policies.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -241,15 +235,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDataPoliciesList(glean);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDataPoliciesList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -309,6 +300,7 @@ Creates a new policy with specified specifications and returns its id.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createpolicy" method="post" path="/rest/api/v1/governance/data/policies" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -319,7 +311,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.data.policies.create({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -342,15 +333,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDataPoliciesCreate(glean, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDataPoliciesCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -398,6 +386,7 @@ Downloads CSV violations report for a specific policy id. This does not support
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="downloadpolicycsv" method="get" path="/rest/api/v1/governance/data/policies/{id}/download" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -408,7 +397,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.data.policies.download("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -431,15 +419,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDataPoliciesDownload(glean, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDataPoliciesDownload failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();