@gleanwork/api-client 0.3.0 → 0.4.1

package/docs/sdks/data/README.md

@@ -0,0 +1,6 @@
+# Data
+(*client.governance.data*)
+
+## Overview
+
+### Available Operations

package/docs/sdks/datasource/README.md

@@ -21,7 +21,9 @@ Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/i
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -45,7 +47,9 @@ import { indexingDatasourceStatus } from "@gleanwork/api-client/funcs/indexingDa
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {

package/docs/sdks/datasources/README.md

@@ -18,7 +18,9 @@ Add or update a custom datasource and its schema.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -34,14 +36,6 @@ async function run() {
           name: "user",
         },
       },
-      {
-        iconConfig: {
-          color: "#343CED",
-          key: "person_icon",
-          iconType: "GLYPH",
-          name: "user",
-        },
-      },
     ],
   });
 
@@ -62,7 +56,9 @@ import { indexingDatasourcesAdd } from "@gleanwork/api-client/funcs/indexingData
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -78,14 +74,6 @@ async function run() {
           name: "user",
         },
       },
-      {
-        iconConfig: {
-          color: "#343CED",
-          key: "person_icon",
-          iconType: "GLYPH",
-          name: "user",
-        },
-      },
     ],
   });
 
@@ -147,7 +135,9 @@ Fetches the datasource config for the specified custom datasource.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -173,7 +163,9 @@ import { indexingDatasourcesRetrieveConfig } from "@gleanwork/api-client/funcs/i
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {

package/docs/sdks/entities/README.md

@@ -18,7 +18,9 @@ List some set of details for all entities that fit the given criteria and return
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -59,7 +61,9 @@ import { clientEntitiesList } from "@gleanwork/api-client/funcs/clientEntitiesLi
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -141,7 +145,9 @@ Read people details for the given IDs.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -170,7 +176,9 @@ import { clientEntitiesReadPeople } from "@gleanwork/api-client/funcs/clientEnti
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {

package/docs/sdks/governance/README.md

@@ -0,0 +1,6 @@
+# Governance
+(*client.governance*)
+
+## Overview
+
+### Available Operations

package/docs/sdks/governancedocuments/README.md

@@ -0,0 +1,6 @@
+# GovernanceDocuments
+(*client.governance.documents*)
+
+## Overview
+
+### Available Operations

package/docs/sdks/indexingauthentication/README.md

@@ -17,7 +17,9 @@ Rotates the secret value inside the Indexing API token and returns the new raw s
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -41,7 +43,9 @@ import { indexingAuthenticationRotateToken } from "@gleanwork/api-client/funcs/i
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {

package/docs/sdks/indexingdocuments/README.md

@@ -28,7 +28,9 @@ Adds a document to the index or updates an existing document.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -55,7 +57,9 @@ import { indexingDocumentsAddOrUpdate } from "@gleanwork/api-client/funcs/indexi
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -123,17 +127,15 @@ Adds or updates multiple documents in the index. Please refer to the [bulk index
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   await glean.indexing.documents.index({
     datasource: "<value>",
-    documents: [
-      {
-        datasource: "<value>",
-      },
-    ],
+    documents: [],
   });
 
 
@@ -153,17 +155,15 @@ import { indexingDocumentsIndex } from "@gleanwork/api-client/funcs/indexingDocu
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const res = await indexingDocumentsIndex(glean, {
     datasource: "<value>",
-    documents: [
-      {
-        datasource: "<value>",
-      },
-    ],
+    documents: [],
   });
 
   if (!res.ok) {
@@ -224,18 +224,16 @@ Replaces the documents in a datasource using paginated batch API calls. Please r
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   await glean.indexing.documents.bulkIndex({
     uploadId: "<id>",
     datasource: "<value>",
-    documents: [
-      {
-        datasource: "<value>",
-      },
-    ],
+    documents: [],
   });
 
 
@@ -255,18 +253,16 @@ import { indexingDocumentsBulkIndex } from "@gleanwork/api-client/funcs/indexing
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const res = await indexingDocumentsBulkIndex(glean, {
     uploadId: "<id>",
     datasource: "<value>",
-    documents: [
-      {
-        datasource: "<value>",
-      },
-    ],
+    documents: [],
   });
 
   if (!res.ok) {
@@ -338,7 +334,9 @@ For more frequent document processing, contact Glean support.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -361,7 +359,9 @@ import { indexingDocumentsProcessAll } from "@gleanwork/api-client/funcs/indexin
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -425,7 +425,9 @@ Deletes the specified document from the index. Succeeds if document is not prese
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -452,7 +454,9 @@ import { indexingDocumentsDelete } from "@gleanwork/api-client/funcs/indexingDoc
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -523,7 +527,9 @@ Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/i
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -550,7 +556,9 @@ import { indexingDocumentsDebug } from "@gleanwork/api-client/funcs/indexingDocu
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -622,7 +630,9 @@ Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/i
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -632,10 +642,6 @@ async function run() {
         objectType: "Article",
         docId: "art123",
       },
-      {
-        objectType: "Article",
-        docId: "art123",
-      },
     ],
   }, "<value>");
 
@@ -657,7 +663,9 @@ import { indexingDocumentsDebugMany } from "@gleanwork/api-client/funcs/indexing
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -667,10 +675,6 @@ async function run() {
         objectType: "Article",
         docId: "art123",
       },
-      {
-        objectType: "Article",
-        docId: "art123",
-      },
     ],
   }, "<value>");
 
@@ -737,7 +741,9 @@ Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/i
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -766,7 +772,9 @@ import { indexingDocumentsCheckAccess } from "@gleanwork/api-client/funcs/indexi
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -841,7 +849,9 @@ Tip: Use [/debug/{datasource}/document](https://developers.glean.com/docs/indexi
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -869,7 +879,9 @@ import { indexingDocumentsStatus } from "@gleanwork/api-client/funcs/indexingDoc
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -943,7 +955,9 @@ Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -969,7 +983,9 @@ import { indexingDocumentsCount } from "@gleanwork/api-client/funcs/indexingDocu
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {

package/docs/sdks/indexingshortcuts/README.md

@@ -18,7 +18,9 @@ Replaces all the currently indexed shortcuts using paginated batch API calls. No
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -27,9 +29,15 @@ async function run() {
     shortcuts: [
       {
         inputAlias: "<value>",
-        destinationUrl: "https://only-juggernaut.com/",
+        destinationUrl: "https://plump-tune-up.biz/",
         createdBy: "<value>",
-        intermediateUrl: "https://descriptive-electronics.name",
+        intermediateUrl: "https://lean-sightseeing.net",
+      },
+      {
+        inputAlias: "<value>",
+        destinationUrl: "https://plump-tune-up.biz/",
+        createdBy: "<value>",
+        intermediateUrl: "https://lean-sightseeing.net",
       },
     ],
   });
@@ -51,7 +59,9 @@ import { indexingShortcutsBulkIndex } from "@gleanwork/api-client/funcs/indexing
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -60,9 +70,15 @@ async function run() {
     shortcuts: [
       {
         inputAlias: "<value>",
-        destinationUrl: "https://only-juggernaut.com/",
+        destinationUrl: "https://plump-tune-up.biz/",
+        createdBy: "<value>",
+        intermediateUrl: "https://lean-sightseeing.net",
+      },
+      {
+        inputAlias: "<value>",
+        destinationUrl: "https://plump-tune-up.biz/",
         createdBy: "<value>",
-        intermediateUrl: "https://descriptive-electronics.name",
+        intermediateUrl: "https://lean-sightseeing.net",
       },
     ],
   });
@@ -125,7 +141,9 @@ Creates glean shortcuts for uploaded shortcuts info. Glean would host the shortc
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -134,7 +152,17 @@ async function run() {
     shortcuts: [
       {
         inputAlias: "<value>",
-        destinationUrl: "https://needy-harp.name",
+        destinationUrl: "https://majestic-pharmacopoeia.info/",
+        createdBy: "<value>",
+      },
+      {
+        inputAlias: "<value>",
+        destinationUrl: "https://majestic-pharmacopoeia.info/",
+        createdBy: "<value>",
+      },
+      {
+        inputAlias: "<value>",
+        destinationUrl: "https://majestic-pharmacopoeia.info/",
         createdBy: "<value>",
       },
     ],
@@ -157,7 +185,9 @@ import { indexingShortcutsUpload } from "@gleanwork/api-client/funcs/indexingSho
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
@@ -166,7 +196,17 @@ async function run() {
     shortcuts: [
       {
         inputAlias: "<value>",
-        destinationUrl: "https://needy-harp.name",
+        destinationUrl: "https://majestic-pharmacopoeia.info/",
+        createdBy: "<value>",
+      },
+      {
+        inputAlias: "<value>",
+        destinationUrl: "https://majestic-pharmacopoeia.info/",
+        createdBy: "<value>",
+      },
+      {
+        inputAlias: "<value>",
+        destinationUrl: "https://majestic-pharmacopoeia.info/",
         createdBy: "<value>",
       },
     ],

package/docs/sdks/insights/README.md

@@ -17,13 +17,17 @@ Reads the aggregate information for each user, query, and content.
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const result = await glean.client.insights.retrieve({
     categories: [
-      "USERS",
+      "COLLECTIONS",
+      "SHORTCUTS",
+      "ANNOUNCEMENTS",
     ],
   });
 
@@ -45,13 +49,17 @@ import { clientInsightsRetrieve } from "@gleanwork/api-client/funcs/clientInsigh
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const res = await clientInsightsRetrieve(glean, {
     categories: [
-      "USERS",
+      "COLLECTIONS",
+      "SHORTCUTS",
+      "ANNOUNCEMENTS",
     ],
   });
 

package/docs/sdks/messages/README.md

@@ -17,12 +17,14 @@ Retrieves list of messages from messaging/chat datasources (e.g. Slack, Teams).
 import { Glean } from "@gleanwork/api-client";
 
 const glean = new Glean({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const result = await glean.client.messages.retrieve({
-    idType: "THREAD_ID",
+    idType: "CONVERSATION_ID",
     id: "<id>",
   });
 
@@ -44,12 +46,14 @@ import { clientMessagesRetrieve } from "@gleanwork/api-client/funcs/clientMessag
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const glean = new GleanCore({
-  apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  security: {
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "",
+  },
 });
 
 async function run() {
   const res = await clientMessagesRetrieve(glean, {
-    idType: "THREAD_ID",
+    idType: "CONVERSATION_ID",
     id: "<id>",
   });