@gleanwork/api-client 0.10.3 → 0.11.0

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

package/docs/sdks/reports/README.md

@@ -15,6 +15,7 @@ Creates a new one-time report and executes its batch job.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createreport" method="post" path="/rest/api/v1/governance/data/reports" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -25,7 +26,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.data.reports.create({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -48,15 +48,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDataReportsCreate(glean, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDataReportsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -104,6 +101,7 @@ Downloads CSV violations report for a specific report id.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="downloadreportcsv" method="get" path="/rest/api/v1/governance/data/reports/{id}/download" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -114,7 +112,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.data.reports.download("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -137,15 +134,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDataReportsDownload(glean, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDataReportsDownload failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -204,6 +198,7 @@ Fetches the status of the run corresponding to the report-id.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getreportstatus" method="get" path="/rest/api/v1/governance/data/reports/{id}/status" -->
 ```typescript
 import { Glean } from "@gleanwork/api-client";
 
@@ -214,7 +209,6 @@ const glean = new Glean({
 async function run() {
   const result = await glean.client.governance.data.reports.status("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -237,15 +231,12 @@ const glean = new GleanCore({
 
 async function run() {
   const res = await clientGovernanceDataReportsStatus(glean, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("clientGovernanceDataReportsStatus failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();