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

package/docs/sdks/clientshortcuts/README.md

@@ -5,228 +5,12 @@
 
 ### Available Operations
 
-* [create](#create) - Create shortcut
 * [delete](#delete) - Delete shortcut
-* [get](#get) - Read shortcut
+* [retrieve](#retrieve) - Read shortcut
 * [list](#list) - List shortcuts
 * [update](#update) - Update shortcut
 * [upload](#upload) - Upload shortcuts
 
-## create
-
-Create a user-generated shortcut that contains an alias and destination URL.
-
-### Example Usage
-
-```typescript
-import { Glean } from "@gleanwork/api-client";
-import { RFCDate } from "@gleanwork/api-client/types";
-
-const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-
-async function run() {
-  const result = await glean.client.shortcuts.create({
-    data: {
-      addedRoles: [
-        {
-          person: {
-            name: "George Clooney",
-            obfuscatedId: "abc123",
-            relatedDocuments: [],
-            metadata: {
-              type: "FULL_TIME",
-              title: "Actor",
-              department: "Movies",
-              email: "george@example.com",
-              location: "Hollywood, CA",
-              phone: "6505551234",
-              photoUrl: "https://example.com/george.jpg",
-              startDate: new RFCDate("2000-01-23"),
-              datasourceProfile: [
-                {
-                  datasource: "github",
-                  handle: "<value>",
-                },
-              ],
-              querySuggestions: {
-                suggestions: [],
-              },
-              inviteInfo: {
-                invites: [],
-              },
-              customFields: [],
-              badges: [
-                {
-                  key: "deployment_name_new_hire",
-                  displayName: "New hire",
-                  iconConfig: {
-                    color: "#343CED",
-                    key: "person_icon",
-                    iconType: "GLYPH",
-                    name: "user",
-                  },
-                },
-              ],
-            },
-          },
-          role: "OWNER",
-        },
-        {
-          role: "VERIFIER",
-        },
-      ],
-      removedRoles: [
-        {
-          role: "VERIFIER",
-        },
-        {
-          role: "ANSWER_MODERATOR",
-        },
-        {
-          role: "OWNER",
-        },
-      ],
-    },
-  });
-
-  // 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 { clientShortcutsCreate } from "@gleanwork/api-client/funcs/clientShortcutsCreate.js";
-import { RFCDate } from "@gleanwork/api-client/types";
-
-// 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 clientShortcutsCreate(glean, {
-    data: {
-      addedRoles: [
-        {
-          person: {
-            name: "George Clooney",
-            obfuscatedId: "abc123",
-            relatedDocuments: [],
-            metadata: {
-              type: "FULL_TIME",
-              title: "Actor",
-              department: "Movies",
-              email: "george@example.com",
-              location: "Hollywood, CA",
-              phone: "6505551234",
-              photoUrl: "https://example.com/george.jpg",
-              startDate: new RFCDate("2000-01-23"),
-              datasourceProfile: [
-                {
-                  datasource: "github",
-                  handle: "<value>",
-                },
-              ],
-              querySuggestions: {
-                suggestions: [],
-              },
-              inviteInfo: {
-                invites: [],
-              },
-              customFields: [],
-              badges: [
-                {
-                  key: "deployment_name_new_hire",
-                  displayName: "New hire",
-                  iconConfig: {
-                    color: "#343CED",
-                    key: "person_icon",
-                    iconType: "GLYPH",
-                    name: "user",
-                  },
-                },
-              ],
-            },
-          },
-          role: "OWNER",
-        },
-        {
-          role: "VERIFIER",
-        },
-      ],
-      removedRoles: [
-        {
-          role: "VERIFIER",
-        },
-        {
-          role: "ANSWER_MODERATOR",
-        },
-        {
-          role: "OWNER",
-        },
-      ],
-    },
-  });
-
-  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.
-  useClientShortcutsCreateMutation
-} from "@gleanwork/api-client/react-query/clientShortcutsCreate.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.CreateShortcutRequest](../../models/components/createshortcutrequest.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.CreateShortcutResponse](../../models/components/createshortcutresponse.md)\>**
-
-### Errors
-
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-
 ## delete
 
 Delete an existing user-generated shortcut.
@@ -318,7 +102,7 @@ import {
 | ----------------- | ----------------- | ----------------- |
 | errors.GleanError | 4XX, 5XX          | \*/\*             |
 
-## get
+## retrieve
 
 Read a particular shortcut's details given its ID.
 
@@ -332,7 +116,7 @@ const glean = new Glean({
 });
 
 async function run() {
-  const result = await glean.client.shortcuts.get({
+  const result = await glean.client.shortcuts.retrieve({
     alias: "<value>",
   });
 
@@ -349,7 +133,7 @@ The standalone function version of this method:
 
 ```typescript
 import { GleanCore } from "@gleanwork/api-client/core.js";
-import { clientShortcutsGet } from "@gleanwork/api-client/funcs/clientShortcutsGet.js";
+import { clientShortcutsRetrieve } from "@gleanwork/api-client/funcs/clientShortcutsRetrieve.js";
 
 // Use `GleanCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -358,7 +142,7 @@ const glean = new GleanCore({
 });
 
 async function run() {
-  const res = await clientShortcutsGet(glean, {
+  const res = await clientShortcutsRetrieve(glean, {
     alias: "<value>",
   });
 
@@ -388,8 +172,8 @@ associated utilities.
 ```tsx
 import {
   // Mutation hook for triggering the API call.
-  useClientShortcutsGetMutation
-} from "@gleanwork/api-client/react-query/clientShortcutsGet.js";
+  useClientShortcutsRetrieveMutation
+} from "@gleanwork/api-client/react-query/clientShortcutsRetrieve.js";
 ```
 
 ### Parameters

package/docs/sdks/clientverification/README.md

@@ -0,0 +1,191 @@
+# ClientVerification
+(*client.verification*)
+
+## Overview
+
+### Available Operations
+
+* [addReminder](#addreminder) - Create verification
+* [list](#list) - List verifications
+
+## 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          | \*/\*             |