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

package/docs/sdks/clientshortcuts/README.md

@@ -5,11 +5,226 @@
 
 ### Available Operations
 
+* [create](#create) - Create shortcut
 * [delete](#delete) - Delete 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
 
@@ -116,9 +331,7 @@ const glean = new Glean({
 });
 
 async function run() {
-  const result = await glean.client.shortcuts.retrieve({
-    alias: "<value>",
-  });
+  const result = await glean.client.shortcuts.retrieve({});
 
   // Handle the result
   console.log(result);
@@ -142,9 +355,7 @@ const glean = new GleanCore({
 });
 
 async function run() {
-  const res = await clientShortcutsRetrieve(glean, {
-    alias: "<value>",
-  });
+  const res = await clientShortcutsRetrieve(glean, {});
 
   if (!res.ok) {
     throw res.error;
@@ -355,6 +566,14 @@ async function run() {
                 datasource: "github",
                 handle: "<value>",
               },
+              {
+                datasource: "github",
+                handle: "<value>",
+              },
+              {
+                datasource: "github",
+                handle: "<value>",
+              },
             ],
             querySuggestions: {
               suggestions: [],
@@ -377,18 +596,21 @@ async function run() {
             ],
           },
         },
-        role: "EDITOR",
+        role: "ANSWER_MODERATOR",
       },
       {
-        role: "ANSWER_MODERATOR",
+        role: "EDITOR",
       },
     ],
     removedRoles: [
       {
-        role: "EDITOR",
+        role: "VIEWER",
       },
       {
-        role: "ANSWER_MODERATOR",
+        role: "OWNER",
+      },
+      {
+        role: "VIEWER",
       },
     ],
   });
@@ -438,6 +660,14 @@ async function run() {
                 datasource: "github",
                 handle: "<value>",
               },
+              {
+                datasource: "github",
+                handle: "<value>",
+              },
+              {
+                datasource: "github",
+                handle: "<value>",
+              },
             ],
             querySuggestions: {
               suggestions: [],
@@ -460,18 +690,21 @@ async function run() {
             ],
           },
         },
-        role: "EDITOR",
+        role: "ANSWER_MODERATOR",
       },
       {
-        role: "ANSWER_MODERATOR",
+        role: "EDITOR",
       },
     ],
     removedRoles: [
       {
-        role: "EDITOR",
+        role: "VIEWER",
       },
       {
-        role: "ANSWER_MODERATOR",
+        role: "OWNER",
+      },
+      {
+        role: "VIEWER",
       },
     ],
   });
@@ -521,111 +754,6 @@ import {
 
 ### Errors
 
-| Error Type        | Status Code       | Content Type      |
-| ----------------- | ----------------- | ----------------- |
-| errors.GleanError | 4XX, 5XX          | \*/\*             |
-
-## upload
-
-Creates glean shortcuts for uploaded shortcuts info. Glean would host the shortcuts, and they can be managed in the knowledge tab once uploaded.
-
-### Example Usage
-
-```typescript
-import { Glean } from "@gleanwork/api-client";
-
-const glean = new Glean({
-  bearerAuth: process.env["GLEAN_BEARER_AUTH"] ?? "",
-});
-
-async function run() {
-  await glean.client.shortcuts.upload({
-    uploadId: "<id>",
-    shortcuts: [
-      {
-        inputAlias: "<value>",
-        destinationUrl: "https://needy-harp.name",
-        createdBy: "<value>",
-      },
-    ],
-  });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GleanCore } from "@gleanwork/api-client/core.js";
-import { clientShortcutsUpload } from "@gleanwork/api-client/funcs/clientShortcutsUpload.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 clientShortcutsUpload(glean, {
-    uploadId: "<id>",
-    shortcuts: [
-      {
-        inputAlias: "<value>",
-        destinationUrl: "https://needy-harp.name",
-        createdBy: "<value>",
-      },
-    ],
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  
-}
-
-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.
-  useClientShortcutsUploadMutation
-} from "@gleanwork/api-client/react-query/clientShortcutsUpload.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.UploadShortcutsRequest](../../models/components/uploadshortcutsrequest.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\<void\>**
-
-### Errors
-
 | Error Type        | Status Code       | Content Type      |
 | ----------------- | ----------------- | ----------------- |
 | errors.GleanError | 4XX, 5XX          | \*/\*             |