@gleanwork/api-client 0.1.0-beta.4 → 0.1.0-beta.6

package/docs/sdks/verification/README.md

@@ -1,196 +1,12 @@
 # Verification
-(*client.verification*)
+(*verification*)
 
 ## Overview
 
 ### Available Operations
 
-* [addReminder](#addreminder) - Create verification
-* [list](#list) - List verifications
 * [verify](#verify) - Update verification
 
-## addReminder
-
-Creates a verification reminder for the document. Users can create verification reminders from different product surfaces.
-
-### Example Usage
-
-```typescript
-import { Glean } from "@gleanwork/api-client";
-
-const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-
-async function run() {
-  const result = await glean.client.verification.addReminder({
-    documentId: "<id>",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { clientVerificationAddReminder } from "@gleanwork/api-client/funcs/clientVerificationAddReminder.js";
-
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-
-async function run() {
-  const res = await clientVerificationAddReminder(glean, {
-    documentId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### React hooks and utilities
-
-This method can be used in React components through the following hooks and
-associated utilities.
-
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-
-[hook-guide]: ../../../REACT_QUERY.md
-
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useClientVerificationAddReminderMutation
-} from "@gleanwork/api-client/react-query/clientVerificationAddReminder.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.ReminderRequest](../../models/components/reminderrequest.md)                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.Verification](../../models/components/verification.md)\>**
-
-### Errors
-
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-
-## list
-
-Returns the information to be rendered in verification dashboard. Includes information for each document owned by user regarding their verifications.
-
-### Example Usage
-
-```typescript
-import { Glean } from "@gleanwork/api-client";
-
-const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-
-async function run() {
-  const result = await glean.client.verification.list();
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { clientVerificationList } from "@gleanwork/api-client/funcs/clientVerificationList.js";
-
-// Use `GleanCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const glean = new GleanCore({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-
-async function run() {
-  const res = await clientVerificationList(glean);
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### React hooks and utilities
-
-This method can be used in React components through the following hooks and
-associated utilities.
-
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-
-[hook-guide]: ../../../REACT_QUERY.md
-
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useClientVerificationListMutation
-} from "@gleanwork/api-client/react-query/clientVerificationList.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `count`                                                                                                                                                                        | *number*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | Maximum number of documents to return                                                                                                                                          |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[components.VerificationFeed](../../models/components/verificationfeed.md)\>**
-
-### Errors
-
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-
 ## verify
 
 Verify documents to keep the knowledge up to date within customer corpus.
@@ -205,7 +21,7 @@ const glean = new Glean({
 });
 
 async function run() {
-  const result = await glean.client.verification.verify({
+  const result = await glean.verification.verify({
     documentId: "<id>",
   });
 
@@ -222,7 +38,7 @@ The standalone function version of this method:
 
 ```typescript
 import { GleanCore } from "@gleanwork/api-client/core.js";
-import { clientVerificationVerify } from "@gleanwork/api-client/funcs/clientVerificationVerify.js";
+import { verificationVerify } from "@gleanwork/api-client/funcs/verificationVerify.js";
 
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -231,7 +47,7 @@ const glean = new GleanCore({
 });
 
 async function run() {
-  const res = await clientVerificationVerify(glean, {
+  const res = await verificationVerify(glean, {
     documentId: "<id>",
   });
 
@@ -261,8 +77,8 @@ associated utilities.
 ```tsx
 import {
   // Mutation hook for triggering the API call.
-  useClientVerificationVerifyMutation
-} from "@gleanwork/api-client/react-query/clientVerificationVerify.js";
+  useVerificationVerifyMutation
+} from "@gleanwork/api-client/react-query/verificationVerify.js";
 ```
 
 ### Parameters

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@gleanwork/api-client",
-  "version": "0.1.0-beta.4",
+  "version": "0.1.0-beta.6",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gleanwork/api-client",
-  "version": "0.1.0-beta.4",
+  "version": "0.1.0-beta.6",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {

package/src/__tests__/activities.test.ts

@@ -15,7 +15,7 @@ test("Activities Feedback", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  await glean.client.activities.reportActivity({
+  await glean.client.activity.feedback({
     trackingTokens: [
       "trackingTokens",
     ],

package/src/__tests__/agents.test.ts

@@ -15,7 +15,7 @@ test("Agents Runagent", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.agents.runagent({});
+  const result = await glean.client.agents.agent.run({});
   expect(result).toBeDefined();
 });
 
@@ -28,7 +28,7 @@ test("Agents Listagents", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.agents.listagents();
+  const result = await glean.client.agents.list();
   expect(result).toBeDefined();
 });
 
@@ -41,6 +41,6 @@ test("Agents Getagentinputs", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.agents.getagentinputs({});
+  const result = await glean.client.agents.agent.inputs.retrieve({});
   expect(result).toBeDefined();
 });

package/src/__tests__/answers.test.ts

@@ -139,7 +139,7 @@ test("Answers Editanswer", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.answers.edit({
+  const result = await glean.client.answers.update({
     id: 3,
     docId: "ANSWERS_answer_3",
     question: "Why is the sky blue?",
@@ -235,7 +235,7 @@ test("Answers Getanswer", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.answers.get({
+  const result = await glean.client.answers.retrieve({
     id: 3,
     docId: "ANSWERS_answer_3",
   });

package/src/__tests__/chat.test.ts

@@ -74,7 +74,7 @@ test("Chat Getchat", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.chat.get({
+  const result = await glean.client.chat.retrieve({
     id: "<id>",
   });
   expect(result).toBeDefined();
@@ -102,7 +102,7 @@ test("Chat Getchatapplication", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.chat.getApplication({
+  const result = await glean.client.chat.application.retrieve({
     id: "<id>",
   });
   expect(result).toBeDefined();
@@ -117,7 +117,7 @@ test("Chat Uploadchatfiles", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.chat.uploadFiles({
+  const result = await glean.client.chat.files.upload({
     files: [],
   });
   expect(result).toBeDefined();
@@ -132,7 +132,7 @@ test("Chat Getchatfiles", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.chat.getFiles({
+  const result = await glean.client.chat.files.retrieve({
     fileIds: [
       "<value>",
       "<value>",
@@ -150,7 +150,7 @@ test("Chat Deletechatfiles", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  await glean.client.chat.deleteFiles({
+  await glean.client.chat.files.delete({
     fileIds: [
       "<value>",
     ],
@@ -166,7 +166,7 @@ test("Chat Chat Stream Default Example", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.chat.chatStream({
+  const result = await glean.client.chat.createStream({
     messages: [
       {
         fragments: [
@@ -189,7 +189,7 @@ test("Chat Chat Stream Gpt Agent Example", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.chat.chatStream({
+  const result = await glean.client.chat.createStream({
     messages: [
       {
         fragments: [
@@ -215,7 +215,7 @@ test("Chat Chat Stream Streaming Example", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.chat.chatStream({
+  const result = await glean.client.chat.createStream({
     messages: [
       {
         citations: [
@@ -716,7 +716,7 @@ test("Chat Chat Stream Update Response", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.chat.chatStream({
+  const result = await glean.client.chat.createStream({
     messages: [
       {
         citations: [
@@ -1031,7 +1031,7 @@ test("Chat Chat Stream Citation Response", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.chat.chatStream({
+  const result = await glean.client.chat.createStream({
     messages: [],
     timeoutMillis: 30000,
   });

package/src/__tests__/clientdocuments.test.ts

@@ -15,7 +15,7 @@ test("Client Documents Getdocpermissions", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.documents.getPermissions({});
+  const result = await glean.client.documents.permissions.retrieve({});
   expect(result).toBeDefined();
 });
 
@@ -28,7 +28,7 @@ test("Client Documents Getdocuments", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.documents.get();
+  const result = await glean.client.documents.retrieve();
   expect(result).toBeDefined();
 });
 
@@ -41,7 +41,7 @@ test("Client Documents Getdocumentsbyfacets", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.documents.getByFacets({
+  const result = await glean.client.documents.retrieveByFacets({
     filterSets: [
       {
         filters: [

package/src/__tests__/clientshortcuts.test.ts

@@ -16,7 +16,7 @@ test("Client Shortcuts Createshortcut", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.shortcuts.create({
+  const result = await glean.shortcuts.createshortcut({
     data: {
       addedRoles: [
         {
@@ -105,7 +105,7 @@ test("Client Shortcuts Getshortcut", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.shortcuts.get({
+  const result = await glean.client.shortcuts.retrieve({
     alias: "<value>",
   });
   expect(result).toBeDefined();

package/src/__tests__/collections.test.ts

@@ -137,7 +137,7 @@ test("Collections Deletecollectionitem", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.collections.deleteItem({
+  const result = await glean.client.collections.item.delete({
     collectionId: 1357.59,
     itemId: "<id>",
   });
@@ -240,7 +240,7 @@ test("Collections Editcollectionitem", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.collections.editItem({
+  const result = await glean.client.collections.item.update({
     collectionId: 795203,
     itemId: "<id>",
   });
@@ -256,7 +256,7 @@ test("Collections Getcollection", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.collections.get({
+  const result = await glean.client.collections.retrieve({
     id: 700347,
   });
   expect(result).toBeDefined();

package/src/__tests__/datasources.test.ts

@@ -52,7 +52,7 @@ test("Datasources Post /Api/index/v1 /Getdatasourceconfig", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.indexing.datasources.getConfig({
+  const result = await glean.indexing.datasources.config.retrieve({
     datasource: "<value>",
   });
   expect(result).toBeDefined();

package/src/__tests__/insights.test.ts

@@ -15,7 +15,7 @@ test("Insights Insights", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.insights.get({
+  const result = await glean.client.insights.retrieve({
     categories: [
       "CONTENT",
       "CONTENT",

package/src/__tests__/messages.test.ts

@@ -15,7 +15,7 @@ test("Messages Messages", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.messages.get({
+  const result = await glean.client.messages.retrieve({
     idType: "CONVERSATION_ID",
     id: "<id>",
     timestampMillis: 558834,

package/src/__tests__/pins.test.ts

@@ -15,7 +15,7 @@ test("Pins Editpin", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.pins.edit({
+  const result = await glean.client.pins.update({
     audienceFilters: [
       {
         fieldName: "type",
@@ -44,7 +44,7 @@ test("Pins Getpin", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.pins.get({});
+  const result = await glean.client.pins.retrieve({});
   expect(result).toBeDefined();
 });
 

package/src/__tests__/search.test.ts

@@ -16,7 +16,7 @@ test("Search Adminsearch", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.search.admin({
+  const result = await glean.client.search.admin.query({
     trackingToken: "trackingToken",
     pageSize: 10,
     query: "vacation policy",
@@ -60,7 +60,7 @@ test("Search Autocomplete", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.search.autocomplete({
+  const result = await glean.search.autocomplete({
     trackingToken: "trackingToken",
     query: "San Fra",
     datasource: "GDRIVE",
@@ -87,7 +87,7 @@ test("Search Feed", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.search.getFeed({});
+  const result = await glean.client.search.feed.retrieve({});
   expect(result).toBeDefined();
 });
 
@@ -247,7 +247,7 @@ test("Search Search", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.search.execute({
+  const result = await glean.client.search.query({
     trackingToken: "trackingToken",
     pageSize: 10,
     query: "vacation policy",

package/src/__tests__/troubleshooting.test.ts

@@ -43,7 +43,7 @@ test("Troubleshooting Post /Api/index/v1 /Getdocumentstatus", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.indexing.troubleshooting.getStatus({
+  const result = await glean.indexing.troubleshooting.documents.status({
     datasource: "<value>",
     objectType: "<value>",
     docId: "<id>",
@@ -62,7 +62,7 @@ test("Troubleshooting Post /Api/index/v1 /Getdocumentcount", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.indexing.troubleshooting.getDocumentCount({
+  const result = await glean.indexing.troubleshooting.documents.count({
     datasource: "<value>",
   });
   expect(result).toBeDefined();
@@ -79,7 +79,7 @@ test("Troubleshooting Post /Api/index/v1 /Getusercount", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.indexing.troubleshooting.getUserCount({
+  const result = await glean.indexing.troubleshooting.users.count({
     datasource: "<value>",
   });
   expect(result).toBeDefined();

package/src/__tests__/verification.test.ts

@@ -43,7 +43,7 @@ test("Verification Verify", async () => {
     bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "value",
   });
 
-  const result = await glean.client.verification.verify({
+  const result = await glean.verification.verify({
     documentId: "<id>",
   });
   expect(result).toBeDefined();