@gleanwork/api-client 0.13.4 → 0.13.6

package/dist/esm/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAInD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAIxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC"}

package/examples/package-lock.json

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "@gleanwork/api-client",
-      "version": "0.13.4",
+      "version": "0.13.6",
       "dependencies": {
         "zod": "^3.25.0 || ^4.0.0"
       },

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@gleanwork/api-client",
-  "version": "0.13.4",
+  "version": "0.13.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.13.4",
+  "version": "0.13.6",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {

package/src/__tests__/summarize.test.ts

@@ -18,12 +18,11 @@ test("Summarize Summarize", async () => {
   const result = await glean.client.documents.summarize({
     documentSpecs: [
       {
-        ugcType: "SHORTCUTS",
-        contentId: 602763,
+        ugcType: "ANNOUNCEMENTS",
+        contentId: 936916,
       },
       {
-        ugcType: "SHORTCUTS",
-        contentId: 602763,
+        url: "https://ruddy-massage.net",
       },
     ],
   });

package/src/lib/config.ts

@@ -68,8 +68,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.9.0",
-  sdkVersion: "0.13.4",
-  genVersion: "2.743.2",
+  sdkVersion: "0.13.6",
+  genVersion: "2.753.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.13.4 2.743.2 0.9.0 @gleanwork/api-client",
+    "speakeasy-sdk/typescript 0.13.6 2.753.1 0.9.0 @gleanwork/api-client",
 } as const;

package/src/models/components/activityevent.ts

@@ -14,12 +14,33 @@ import {
  * The type of activity this represents.
  */
 export const ActivityEventAction = {
+  /**
+   * Represents a visit to the given `url`.
+   */
   View: "VIEW",
+  /**
+   * Represents an edit of the document represented by the `url`.
+   */
   Edit: "EDIT",
+  /**
+   * Represents a search performed at the given `url`.
+   */
   Search: "SEARCH",
+  /**
+   * Represents a comment on the document represented by the `url`.
+   */
   Comment: "COMMENT",
+  /**
+   * Represents an explicit request to index the given `url` along with associated attributes in this payload.
+   */
   Crawl: "CRAWL",
+  /**
+   * Represents a search performed at the given `url` as indicated by the user's history.
+   */
   HistoricalSearch: "HISTORICAL_SEARCH",
+  /**
+   * Represents a visit to the given `url` as indicated by the user's history.
+   */
   HistoricalView: "HISTORICAL_VIEW",
 } as const;
 /**

package/src/models/components/agentconfig.ts

@@ -18,10 +18,25 @@ import {
  * Name of the agent.
  */
 export const AgentEnum = {
+  /**
+   * Integrates with your company's knowledge. This will soon be deprecated in favor of the FAST and ADVANCED `agent` values
+   */
   Default: "DEFAULT",
+  /**
+   * Communicates directly with the LLM. This will soon be deprecated in favor of the FAST and ADVANCED `agent` values
+   */
   Gpt: "GPT",
+  /**
+   * Uses both company and web knowledge. This will soon be deprecated in favor of the FAST and ADVANCED `agent` values
+   */
   Universal: "UNIVERSAL",
+  /**
+   * Uses an agent powered by the agentic engine that responds faster but may have lower quality results. Requires the agentic engine to be enabled in the deployment.
+   */
   Fast: "FAST",
+  /**
+   * Uses an agent powered by the agentic engine that thinks for longer and potentially makes more LLM calls to return higher quality results. Requires the agentic engine to be enabled in the deployment.
+   */
   Advanced: "ADVANCED",
 } as const;
 /**
@@ -33,7 +48,13 @@ export type AgentEnum = ClosedEnum<typeof AgentEnum>;
  * Top level modes to run GleanChat in.
  */
 export const Mode = {
+  /**
+   * Used if no mode supplied.
+   */
   Default: "DEFAULT",
+  /**
+   * Deprecated.
+   */
   Quick: "QUICK",
 } as const;
 /**

package/src/models/components/chatmessage.ts

@@ -36,14 +36,41 @@ export type Author = ClosedEnum<typeof Author>;
  * Semantically groups content of a certain type. It can be used for purposes such as differential UI treatment. USER authored messages should be of type CONTENT and do not need `messageType` specified.
  */
 export const MessageType = {
+  /**
+   * An intermediate state message for progress updates.
+   */
   Update: "UPDATE",
+  /**
+   * A user query or response message.
+   */
   Content: "CONTENT",
+  /**
+   * A message providing context in addition to the user query.
+   */
   Context: "CONTEXT",
+  /**
+   * A debug message. Strictly used internally.
+   */
   Debug: "DEBUG",
+  /**
+   * A debug message to be used while debugging Action creation.
+   */
   DebugExternal: "DEBUG_EXTERNAL",
+  /**
+   * A message that describes an error while processing the request.
+   */
   Error: "ERROR",
+  /**
+   * A heading message used to distinguish different sections of the holistic response.
+   */
   Heading: "HEADING",
+  /**
+   * A warning message to be shown to the user.
+   */
   Warning: "WARNING",
+  /**
+   * A message used to for server-side tool auth/use, for request and response.
+   */
   ServerTool: "SERVER_TOOL",
 } as const;
 /**

package/src/models/components/documentvisibility.ts

@@ -9,11 +9,29 @@ import { ClosedEnum } from "../../types/enums.js";
  * The level of visibility of the document as understood by our system.
  */
 export const DocumentVisibility = {
+  /**
+   * Only one person is able to see the document.
+   */
   Private: "PRIVATE",
+  /**
+   * Only specific people and/or groups can see the document.
+   */
   SpecificPeopleAndGroups: "SPECIFIC_PEOPLE_AND_GROUPS",
+  /**
+   * Anyone in the domain with the link can see the document.
+   */
   DomainLink: "DOMAIN_LINK",
+  /**
+   * Anyone in the domain can search for the document.
+   */
   DomainVisible: "DOMAIN_VISIBLE",
+  /**
+   * Anyone with the link can see the document.
+   */
   PublicLink: "PUBLIC_LINK",
+  /**
+   * Anyone on the internet can search for the document.
+   */
   PublicVisible: "PUBLIC_VISIBLE",
 } as const;
 /**

package/src/models/components/facetfiltervalue.ts

@@ -9,10 +9,25 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export const RelationType = {
+  /**
+   * The value is equal to the specified value.
+   */
   Equals: "EQUALS",
+  /**
+   * The value is equal to the specified ID.
+   */
   IdEquals: "ID_EQUALS",
+  /**
+   * The value is less than the specified value.
+   */
   Lt: "LT",
+  /**
+   * The value is greater than the specified value.
+   */
   Gt: "GT",
+  /**
+   * The value is not equal to the specified value.
+   */
   NotEquals: "NOT_EQUALS",
 } as const;
 export type RelationType = ClosedEnum<typeof RelationType>;

package/src/models/components/feedback.ts

@@ -62,36 +62,126 @@ export type FeedbackCategory = ClosedEnum<typeof FeedbackCategory>;
  * The action the user took within a Glean client with respect to the object referred to by the given `trackingToken`.
  */
 export const Event = {
+  /**
+   * The object's primary link was clicked with the intent to view its full representation. Depending on the object type, this may imply an external navigation or navigating to a new page or view within the Glean app.
+   */
   Click: "CLICK",
+  /**
+   * A link to the object's parent container (e.g. the folder in which it's located) was clicked.
+   */
   ContainerClick: "CONTAINER_CLICK",
+  /**
+   * The user copied a link to the primary link.
+   */
   CopyLink: "COPY_LINK",
+  /**
+   * The user creates a document.
+   */
   Create: "CREATE",
+  /**
+   * The user dismissed the object such that it was hidden from view.
+   */
   Dismiss: "DISMISS",
+  /**
+   * The user gave feedback that the object was not useful.
+   */
   Downvote: "DOWNVOTE",
+  /**
+   * The user attempted to send an email.
+   */
   Email: "EMAIL",
+  /**
+   * The user executed the object (e.g. ran a workflow).
+   */
   Execute: "EXECUTE",
+  /**
+   * The user applied a filter.
+   */
   Filter: "FILTER",
+  /**
+   * The first token of a streaming response is received.
+   */
   FirstToken: "FIRST_TOKEN",
+  /**
+   * The user clicked into an interactive element, e.g. the search box.
+   */
   FocusIn: "FOCUS_IN",
+  /**
+   * The final token of a streaming response is received.
+   */
   LastToken: "LAST_TOKEN",
+  /**
+   * The user submitted textual manual feedback regarding the object.
+   */
   ManualFeedback: "MANUAL_FEEDBACK",
+  /**
+   * The user submitted comparative feedback for multiple side-by-side implementations.
+   */
   ManualFeedbackSideBySide: "MANUAL_FEEDBACK_SIDE_BY_SIDE",
+  /**
+   * The user explicitly marked the content as read.
+   */
   MarkAsRead: "MARK_AS_READ",
+  /**
+   * The user attempted to send a message using their default messaing app.
+   */
   Message: "MESSAGE",
+  /**
+   * The user middle clicked the object's primary link with the intent to open its full representation in a new tab.
+   */
   MiddleClick: "MIDDLE_CLICK",
+  /**
+   * The user puts a page out of focus but keeps it in the background.
+   */
   PageBlur: "PAGE_BLUR",
+  /**
+   * The user puts a page in focus, meaning it is the first to receive keyboard events.
+   */
   PageFocus: "PAGE_FOCUS",
+  /**
+   * The user leaves a page and it is unloaded (by clicking a link, closing the tab/window, etc).
+   */
   PageLeave: "PAGE_LEAVE",
+  /**
+   * The user clicked the object's inline preview affordance.
+   */
   Preview: "PREVIEW",
   RelatedClick: "RELATED_CLICK",
+  /**
+   * The user right clicked the object's primary link. This may indicate an intent to open it in a new tab or copy it.
+   */
   RightClick: "RIGHT_CLICK",
+  /**
+   * The user clicked a link to a subsection of the primary object.
+   */
   SectionClick: "SECTION_CLICK",
+  /**
+   * The user has likely seen the object (e.g. took action to make the object visible within the user's viewport).
+   */
   Seen: "SEEN",
+  /**
+   * The user explicitly selected something, eg. a chat response variant they prefer.
+   */
   Select: "SELECT",
+  /**
+   * The user shared the object with another user.
+   */
   Share: "SHARE",
+  /**
+   * The user clicked the object's show more affordance.
+   */
   ShowMore: "SHOW_MORE",
+  /**
+   * The user gave feedback that the object was useful.
+   */
   Upvote: "UPVOTE",
+  /**
+   * The object was visible within the user's viewport.
+   */
   View: "VIEW",
+  /**
+   * The object was visible within the user's viewport.
+   */
   Visible: "VISIBLE",
 } as const;
 /**

package/src/models/components/listentitiesrequest.ts

@@ -43,7 +43,13 @@ export type ListEntitiesRequestIncludeField = ClosedEnum<
  * The type of request being made.
  */
 export const RequestType = {
+  /**
+   * Used by default for all requests and satisfies all standard use cases for list requests. Limited to 10000 entities.
+   */
   Standard: "STANDARD",
+  /**
+   * Used exclusively to return a comprehensive list of all people entities in the organization, typically for audit like purposes. The recommended approach is to sort by FIRST_NAME or LAST_NAME, and use pagination for large organizations.
+   */
   FullDirectory: "FULL_DIRECTORY",
 } as const;
 /**

package/src/models/components/personmetadata.ts

@@ -82,9 +82,21 @@ import {
 } from "./structuredlocation.js";
 
 export const PersonMetadataType = {
+  /**
+   * The person is a current full-time employee of the company.
+   */
   FullTime: "FULL_TIME",
+  /**
+   * The person is a current contractor of the company.
+   */
   Contractor: "CONTRACTOR",
+  /**
+   * The person object represents a non-human actor such as a service or admin account.
+   */
   NonEmployee: "NON_EMPLOYEE",
+  /**
+   * The person is a previous employee of the company.
+   */
   FormerEmployee: "FORMER_EMPLOYEE",
 } as const;
 export type PersonMetadataType = ClosedEnum<typeof PersonMetadataType>;

package/src/models/components/relateddocuments.ts

@@ -31,6 +31,9 @@ import {
  */
 export const Relation = {
   Attachment: "ATTACHMENT",
+  /**
+   * Canonical documents for the entity, such as overview docs, architecture docs elastic.
+   */
   Canonical: "CANONICAL",
   Case: "CASE",
   ContactLower: "contact",

package/src/models/components/searchrequestoptions.ts

@@ -42,10 +42,25 @@ import {
  * Hints for the response content.
  */
 export const ResponseHint = {
+  /**
+   * Return result counts for each result set which has non-zero results, even when the request itself is limited to a subset.
+   */
   AllResultCounts: "ALL_RESULT_COUNTS",
+  /**
+   * Return only facet results.
+   */
   FacetResults: "FACET_RESULTS",
+  /**
+   * Returns result counts for each result set which has non-zero results, as well as other information about the search such as suggested spelling corrections.
+   */
   QueryMetadata: "QUERY_METADATA",
+  /**
+   * Return search result documents.
+   */
   Results: "RESULTS",
+  /**
+   * Return metadata pertaining to spellcheck results.
+   */
   SpellcheckMetadata: "SPELLCHECK_METADATA",
 } as const;
 /**

package/src/models/components/searchresultprominenceenum.ts

@@ -11,8 +11,17 @@ import { ClosedEnum } from "../../types/enums.js";
  * @remarks
  */
 export const SearchResultProminenceEnum = {
+  /**
+   * A high-confidence result that should feature prominently on the page.
+   */
   Hero: "HERO",
+  /**
+   * May not be the best result but should be given additional visual distinction.
+   */
   Promoted: "PROMOTED",
+  /**
+   * Should not be distinct from any other results.
+   */
   Standard: "STANDARD",
 } as const;
 /**

package/src/models/components/sectiontype.ts

@@ -9,8 +9,17 @@ import { ClosedEnum } from "../../types/enums.js";
  * Type of the section. This defines how the section should be interpreted and rendered in the digest.
  */
 export const SectionType = {
+  /**
+   * A standard section for channel-based digests (e.g. from Slack, Teams).
+   */
   Channel: "CHANNEL",
+  /**
+   * A dedicated section that surfaces user mentions (actionable, informative, or all).
+   */
   Mentions: "MENTIONS",
+  /**
+   * A section driven by a generic topic, not tied to any specific channel or instance.
+   */
   Topic: "TOPIC",
 } as const;
 /**

package/src/models/components/structuredresult.ts

@@ -132,8 +132,17 @@ import {
  * The level of visual distinction that should be given to a result.
  */
 export const Prominence = {
+  /**
+   * A high-confidence result that should feature prominently on the page.
+   */
   Hero: "HERO",
+  /**
+   * May not be the best result but should be given additional visual distinction.
+   */
   Promoted: "PROMOTED",
+  /**
+   * Should not be distinct from any other results.
+   */
   Standard: "STANDARD",
 } as const;
 /**

package/src/models/components/toolmetadata.ts

@@ -52,14 +52,15 @@ export const KnowledgeType = {
 export type KnowledgeType = ClosedEnum<typeof KnowledgeType>;
 
 /**
- * Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action.
+ * Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action. MCP - Send a tools/call request to an MCP server to execute the action.
  */
 export const WriteActionType = {
   Redirect: "REDIRECT",
   Execution: "EXECUTION",
+  Mcp: "MCP",
 } as const;
 /**
- * Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action.
+ * Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action. MCP - Send a tools/call request to an MCP server to execute the action.
  */
 export type WriteActionType = ClosedEnum<typeof WriteActionType>;
 
@@ -138,7 +139,7 @@ export type ToolMetadata = {
    */
   lastUpdatedAt?: Date | undefined;
   /**
-   * Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action.
+   * Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action. MCP - Send a tools/call request to an MCP server to execute the action.
    */
   writeActionType?: WriteActionType | undefined;
   /**

package/src/models/components/updatetype.ts

@@ -9,7 +9,13 @@ import { ClosedEnum } from "../../types/enums.js";
  * Optional type classification for the update.
  */
 export const UpdateType = {
+  /**
+   * Updates that require user attention or action
+   */
   Actionable: "ACTIONABLE",
+  /**
+   * Updates that are purely informational
+   */
   Informative: "INFORMATIVE",
 } as const;
 /**

package/src/types/enums.ts

@@ -2,15 +2,64 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import * as z from "zod/v3";
+
 declare const __brand: unique symbol;
 export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+export type ClosedEnum<T extends Readonly<Record<string, string | number>>> =
+  T[keyof T];
+export type OpenEnum<T extends Readonly<Record<string, string | number>>> =
+  | T[keyof T]
+  | Unrecognized<T[keyof T] extends number ? number : string>;
 
-export function catchUnrecognizedEnum<T>(value: T): Unrecognized<T> {
+function unrecognized<T>(value: T): Unrecognized<T> {
+  unrecognizedCount++;
   return value as Unrecognized<T>;
 }
 
-type Prettify<T> = { [K in keyof T]: T[K] } & {};
-export type ClosedEnum<T> = T[keyof T];
-export type OpenEnum<T> =
-  | Prettify<T[keyof T]>
-  | Unrecognized<T[keyof T] extends number ? number : string>;
+let unrecognizedCount = 0;
+let refCount = 0;
+export function unrecognizedCounter() {
+  refCount++;
+  const start = unrecognizedCount;
+  return {
+    count: () => {
+      const count = unrecognizedCount - start;
+      if (--refCount === 0) unrecognizedCount = 0;
+      return count;
+    },
+  };
+}
+
+export function inboundSchema<T extends Record<string, string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  const options = Object.values(enumObj);
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.string().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function inboundSchemaInt<T extends Record<string, number | string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  // For numeric enums, Object.values returns both numbers and string keys
+  const options = Object.values(enumObj).filter(v => typeof v === "number");
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.number().int().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function outboundSchema<T extends Record<string, string>>(
+  _: T,
+): z.ZodType<string, z.ZodTypeDef, OpenEnum<T>> {
+  return z.string() as any;
+}
+
+export function outboundSchemaInt<T extends Record<string, number | string>>(
+  _: T,
+): z.ZodType<number, z.ZodTypeDef, OpenEnum<T>> {
+  return z.number().int() as any;
+}

package/src/types/index.ts

@@ -3,7 +3,6 @@
  */
 
 export { blobLikeSchema, isBlobLike } from "./blobs.js";
-export { catchUnrecognizedEnum } from "./enums.js";
 export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
 export type { Result } from "./fp.js";
 export type { PageIterator, Paginator } from "./operations.js";