@gleanwork/api-client 0.1.0-beta → 0.1.0-beta.2

package/src/models/components/autocompleteresponse.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -19,11 +20,11 @@ import {
   AutocompleteResultGroup$outboundSchema,
 } from "./autocompleteresultgroup.js";
 import {
-  ErrorInfo,
-  ErrorInfo$inboundSchema,
-  ErrorInfo$Outbound,
-  ErrorInfo$outboundSchema,
-} from "./errorinfo.js";
+  GleanDataError,
+  GleanDataError$inboundSchema,
+  GleanDataError$Outbound,
+  GleanDataError$outboundSchema,
+} from "./gleandataerror.js";
 import {
   SessionInfo,
   SessionInfo$inboundSchema,
@@ -46,7 +47,7 @@ export type AutocompleteResponse = {
    * Subsections of the results list from which distinct sections should be created.
    */
   groups?: Array<AutocompleteResultGroup> | undefined;
-  errorInfo?: ErrorInfo | undefined;
+  gleanDataError?: GleanDataError | undefined;
   /**
    * Time in milliseconds the backend took to respond to the request.
    */
@@ -64,8 +65,12 @@ export const AutocompleteResponse$inboundSchema: z.ZodType<
   sessionInfo: SessionInfo$inboundSchema.optional(),
   results: z.array(AutocompleteResult$inboundSchema).optional(),
   groups: z.array(AutocompleteResultGroup$inboundSchema).optional(),
-  errorInfo: ErrorInfo$inboundSchema.optional(),
+  errorInfo: GleanDataError$inboundSchema.optional(),
   backendTimeMillis: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "errorInfo": "gleanDataError",
+  });
 });
 
 /** @internal */
@@ -75,7 +80,7 @@ export type AutocompleteResponse$Outbound = {
   sessionInfo?: SessionInfo$Outbound | undefined;
   results?: Array<AutocompleteResult$Outbound> | undefined;
   groups?: Array<AutocompleteResultGroup$Outbound> | undefined;
-  errorInfo?: ErrorInfo$Outbound | undefined;
+  errorInfo?: GleanDataError$Outbound | undefined;
   backendTimeMillis?: number | undefined;
 };
 
@@ -90,8 +95,12 @@ export const AutocompleteResponse$outboundSchema: z.ZodType<
   sessionInfo: SessionInfo$outboundSchema.optional(),
   results: z.array(AutocompleteResult$outboundSchema).optional(),
   groups: z.array(AutocompleteResultGroup$outboundSchema).optional(),
-  errorInfo: ErrorInfo$outboundSchema.optional(),
+  gleanDataError: GleanDataError$outboundSchema.optional(),
   backendTimeMillis: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    gleanDataError: "errorInfo",
+  });
 });
 
 /**

package/src/models/components/collectionerror.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const CollectionErrorErrorCode = {
+  NameExists: "NAME_EXISTS",
+  NotFound: "NOT_FOUND",
+  CollectionPinned: "COLLECTION_PINNED",
+  ConcurrentHierarchyEdit: "CONCURRENT_HIERARCHY_EDIT",
+  HeightViolation: "HEIGHT_VIOLATION",
+  WidthViolation: "WIDTH_VIOLATION",
+  NoPermissions: "NO_PERMISSIONS",
+} as const;
+export type CollectionErrorErrorCode = ClosedEnum<
+  typeof CollectionErrorErrorCode
+>;
+
+export type CollectionError = {
+  errorCode: CollectionErrorErrorCode;
+};
+
+/** @internal */
+export const CollectionErrorErrorCode$inboundSchema: z.ZodNativeEnum<
+  typeof CollectionErrorErrorCode
+> = z.nativeEnum(CollectionErrorErrorCode);
+
+/** @internal */
+export const CollectionErrorErrorCode$outboundSchema: z.ZodNativeEnum<
+  typeof CollectionErrorErrorCode
+> = CollectionErrorErrorCode$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CollectionErrorErrorCode$ {
+  /** @deprecated use `CollectionErrorErrorCode$inboundSchema` instead. */
+  export const inboundSchema = CollectionErrorErrorCode$inboundSchema;
+  /** @deprecated use `CollectionErrorErrorCode$outboundSchema` instead. */
+  export const outboundSchema = CollectionErrorErrorCode$outboundSchema;
+}
+
+/** @internal */
+export const CollectionError$inboundSchema: z.ZodType<
+  CollectionError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  errorCode: CollectionErrorErrorCode$inboundSchema,
+});
+
+/** @internal */
+export type CollectionError$Outbound = {
+  errorCode: string;
+};
+
+/** @internal */
+export const CollectionError$outboundSchema: z.ZodType<
+  CollectionError$Outbound,
+  z.ZodTypeDef,
+  CollectionError
+> = z.object({
+  errorCode: CollectionErrorErrorCode$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CollectionError$ {
+  /** @deprecated use `CollectionError$inboundSchema` instead. */
+  export const inboundSchema = CollectionError$inboundSchema;
+  /** @deprecated use `CollectionError$outboundSchema` instead. */
+  export const outboundSchema = CollectionError$outboundSchema;
+  /** @deprecated use `CollectionError$Outbound` instead. */
+  export type Outbound = CollectionError$Outbound;
+}
+
+export function collectionErrorToJSON(
+  collectionError: CollectionError,
+): string {
+  return JSON.stringify(CollectionError$outboundSchema.parse(collectionError));
+}
+
+export function collectionErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<CollectionError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CollectionError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CollectionError' from JSON`,
+  );
+}

package/src/models/components/createcollectionresponse.ts

@@ -14,11 +14,11 @@ import {
   Collection$outboundSchema,
 } from "./collection.js";
 import {
-  CollectionError1,
-  CollectionError1$inboundSchema,
-  CollectionError1$Outbound,
-  CollectionError1$outboundSchema,
-} from "./collectionerror1.js";
+  CollectionError,
+  CollectionError$inboundSchema,
+  CollectionError$Outbound,
+  CollectionError$outboundSchema,
+} from "./collectionerror.js";
 import {
   CollectionItem,
   CollectionItem$inboundSchema,
@@ -149,7 +149,7 @@ export type CreateCollectionResponse = {
   roles?: Array<UserRoleSpecification> | undefined;
   errorCode: CreateCollectionResponseErrorCode;
   collection?: Collection | undefined;
-  error?: CollectionError1 | undefined;
+  error?: CollectionError | undefined;
 };
 
 /** @internal */
@@ -207,7 +207,7 @@ export const CreateCollectionResponse$inboundSchema: z.ZodType<
   roles: z.array(UserRoleSpecification$inboundSchema).optional(),
   errorCode: CreateCollectionResponseErrorCode$inboundSchema,
   collection: Collection$inboundSchema.optional(),
-  error: CollectionError1$inboundSchema.optional(),
+  error: CollectionError$inboundSchema.optional(),
 });
 
 /** @internal */
@@ -237,7 +237,7 @@ export type CreateCollectionResponse$Outbound = {
   roles?: Array<UserRoleSpecification$Outbound> | undefined;
   errorCode: string;
   collection?: Collection$Outbound | undefined;
-  error?: CollectionError1$Outbound | undefined;
+  error?: CollectionError$Outbound | undefined;
 };
 
 /** @internal */
@@ -271,7 +271,7 @@ export const CreateCollectionResponse$outboundSchema: z.ZodType<
   roles: z.array(UserRoleSpecification$outboundSchema).optional(),
   errorCode: CreateCollectionResponseErrorCode$outboundSchema,
   collection: Collection$outboundSchema.optional(),
-  error: CollectionError1$outboundSchema.optional(),
+  error: CollectionError$outboundSchema.optional(),
 });
 
 /**

package/src/models/components/editcollectionresponse.ts

@@ -14,11 +14,11 @@ import {
   Collection$outboundSchema,
 } from "./collection.js";
 import {
-  CollectionError2,
-  CollectionError2$inboundSchema,
-  CollectionError2$Outbound,
-  CollectionError2$outboundSchema,
-} from "./collectionerror2.js";
+  CollectionError,
+  CollectionError$inboundSchema,
+  CollectionError$Outbound,
+  CollectionError$outboundSchema,
+} from "./collectionerror.js";
 import {
   CollectionItem,
   CollectionItem$inboundSchema,
@@ -149,7 +149,7 @@ export type EditCollectionResponse = {
   roles?: Array<UserRoleSpecification> | undefined;
   errorCode: EditCollectionResponseErrorCode;
   collection?: Collection | undefined;
-  error?: CollectionError2 | undefined;
+  error?: CollectionError | undefined;
 };
 
 /** @internal */
@@ -206,7 +206,7 @@ export const EditCollectionResponse$inboundSchema: z.ZodType<
   roles: z.array(UserRoleSpecification$inboundSchema).optional(),
   errorCode: EditCollectionResponseErrorCode$inboundSchema,
   collection: Collection$inboundSchema.optional(),
-  error: CollectionError2$inboundSchema.optional(),
+  error: CollectionError$inboundSchema.optional(),
 });
 
 /** @internal */
@@ -236,7 +236,7 @@ export type EditCollectionResponse$Outbound = {
   roles?: Array<UserRoleSpecification$Outbound> | undefined;
   errorCode: string;
   collection?: Collection$Outbound | undefined;
-  error?: CollectionError2$Outbound | undefined;
+  error?: CollectionError$Outbound | undefined;
 };
 
 /** @internal */
@@ -270,7 +270,7 @@ export const EditCollectionResponse$outboundSchema: z.ZodType<
   roles: z.array(UserRoleSpecification$outboundSchema).optional(),
   errorCode: EditCollectionResponseErrorCode$outboundSchema,
   collection: Collection$outboundSchema.optional(),
-  error: CollectionError2$outboundSchema.optional(),
+  error: CollectionError$outboundSchema.optional(),
 });
 
 /**

package/src/models/components/feedback.ts

@@ -104,11 +104,11 @@ export const Event = {
  */
 export type Event = ClosedEnum<typeof Event>;
 
-export const FeedbackChannel1 = {
+export const FeedbackChannel = {
   Company: "COMPANY",
   Glean: "GLEAN",
 } as const;
-export type FeedbackChannel1 = ClosedEnum<typeof FeedbackChannel1>;
+export type FeedbackChannel = ClosedEnum<typeof FeedbackChannel>;
 
 export type Feedback = {
   /**
@@ -148,7 +148,7 @@ export type Feedback = {
   /**
    * Where the feedback will be sent, e.g. to Glean, the user's company, or both. If no channels are specified, feedback will go only to Glean.
    */
-  channels?: Array<FeedbackChannel1> | undefined;
+  channels?: Array<FeedbackChannel> | undefined;
   /**
    * The URL the client was at when the feedback event triggered.
    */
@@ -169,6 +169,10 @@ export type Feedback = {
    * The application ID of the client that sent the feedback event.
    */
   applicationId?: string | undefined;
+  /**
+   * The agent ID of the client that sent the feedback event.
+   */
+  agentId?: string | undefined;
 };
 
 /** @internal */
@@ -213,24 +217,24 @@ export namespace Event$ {
 }
 
 /** @internal */
-export const FeedbackChannel1$inboundSchema: z.ZodNativeEnum<
-  typeof FeedbackChannel1
-> = z.nativeEnum(FeedbackChannel1);
+export const FeedbackChannel$inboundSchema: z.ZodNativeEnum<
+  typeof FeedbackChannel
+> = z.nativeEnum(FeedbackChannel);
 
 /** @internal */
-export const FeedbackChannel1$outboundSchema: z.ZodNativeEnum<
-  typeof FeedbackChannel1
-> = FeedbackChannel1$inboundSchema;
+export const FeedbackChannel$outboundSchema: z.ZodNativeEnum<
+  typeof FeedbackChannel
+> = FeedbackChannel$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace FeedbackChannel1$ {
-  /** @deprecated use `FeedbackChannel1$inboundSchema` instead. */
-  export const inboundSchema = FeedbackChannel1$inboundSchema;
-  /** @deprecated use `FeedbackChannel1$outboundSchema` instead. */
-  export const outboundSchema = FeedbackChannel1$outboundSchema;
+export namespace FeedbackChannel$ {
+  /** @deprecated use `FeedbackChannel$inboundSchema` instead. */
+  export const inboundSchema = FeedbackChannel$inboundSchema;
+  /** @deprecated use `FeedbackChannel$outboundSchema` instead. */
+  export const outboundSchema = FeedbackChannel$outboundSchema;
 }
 
 /** @internal */
@@ -250,7 +254,7 @@ export const Feedback$inboundSchema: z.ZodType<
     .optional(),
   user: User$inboundSchema.optional(),
   pathname: z.string().optional(),
-  channels: z.array(FeedbackChannel1$inboundSchema).optional(),
+  channels: z.array(FeedbackChannel$inboundSchema).optional(),
   url: z.string().optional(),
   uiTree: z.array(z.string()).optional(),
   uiElement: z.string().optional(),
@@ -259,6 +263,7 @@ export const Feedback$inboundSchema: z.ZodType<
   userViewInfo: UserViewInfo$inboundSchema.optional(),
   workflowFeedbackInfo: WorkflowFeedbackInfo$inboundSchema.optional(),
   applicationId: z.string().optional(),
+  agentId: z.string().optional(),
 });
 
 /** @internal */
@@ -282,6 +287,7 @@ export type Feedback$Outbound = {
   userViewInfo?: UserViewInfo$Outbound | undefined;
   workflowFeedbackInfo?: WorkflowFeedbackInfo$Outbound | undefined;
   applicationId?: string | undefined;
+  agentId?: string | undefined;
 };
 
 /** @internal */
@@ -300,7 +306,7 @@ export const Feedback$outboundSchema: z.ZodType<
   timestamp: z.date().transform(v => v.toISOString()).optional(),
   user: User$outboundSchema.optional(),
   pathname: z.string().optional(),
-  channels: z.array(FeedbackChannel1$outboundSchema).optional(),
+  channels: z.array(FeedbackChannel$outboundSchema).optional(),
   url: z.string().optional(),
   uiTree: z.array(z.string()).optional(),
   uiElement: z.string().optional(),
@@ -309,6 +315,7 @@ export const Feedback$outboundSchema: z.ZodType<
   userViewInfo: UserViewInfo$outboundSchema.optional(),
   workflowFeedbackInfo: WorkflowFeedbackInfo$outboundSchema.optional(),
   applicationId: z.string().optional(),
+  agentId: z.string().optional(),
 });
 
 /**

package/src/models/components/feedentry.ts

@@ -89,19 +89,19 @@ import {
 /**
  * defines how to render this particular displayable list card
  */
-export const FeedEntryFormat = {
+export const Format = {
   List: "LIST",
 } as const;
 /**
  * defines how to render this particular displayable list card
  */
-export type FeedEntryFormat = ClosedEnum<typeof FeedEntryFormat>;
+export type Format = ClosedEnum<typeof Format>;
 
 export type UiConfig = {
   /**
    * defines how to render this particular displayable list card
    */
-  format?: FeedEntryFormat | undefined;
+  format?: Format | undefined;
   /**
    * UI configurations for each item of the list
    */
@@ -195,24 +195,22 @@ export type FeedEntry = {
 };
 
 /** @internal */
-export const FeedEntryFormat$inboundSchema: z.ZodNativeEnum<
-  typeof FeedEntryFormat
-> = z.nativeEnum(FeedEntryFormat);
+export const Format$inboundSchema: z.ZodNativeEnum<typeof Format> = z
+  .nativeEnum(Format);
 
 /** @internal */
-export const FeedEntryFormat$outboundSchema: z.ZodNativeEnum<
-  typeof FeedEntryFormat
-> = FeedEntryFormat$inboundSchema;
+export const Format$outboundSchema: z.ZodNativeEnum<typeof Format> =
+  Format$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace FeedEntryFormat$ {
-  /** @deprecated use `FeedEntryFormat$inboundSchema` instead. */
-  export const inboundSchema = FeedEntryFormat$inboundSchema;
-  /** @deprecated use `FeedEntryFormat$outboundSchema` instead. */
-  export const outboundSchema = FeedEntryFormat$outboundSchema;
+export namespace Format$ {
+  /** @deprecated use `Format$inboundSchema` instead. */
+  export const inboundSchema = Format$inboundSchema;
+  /** @deprecated use `Format$outboundSchema` instead. */
+  export const outboundSchema = Format$outboundSchema;
 }
 
 /** @internal */
@@ -221,7 +219,7 @@ export const UiConfig$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  format: FeedEntryFormat$inboundSchema.optional(),
+  format: Format$inboundSchema.optional(),
   additionalFlags: DisplayableListItemUIConfig$inboundSchema.optional(),
 });
 
@@ -237,7 +235,7 @@ export const UiConfig$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UiConfig
 > = z.object({
-  format: FeedEntryFormat$outboundSchema.optional(),
+  format: Format$outboundSchema.optional(),
   additionalFlags: DisplayableListItemUIConfig$outboundSchema.optional(),
 });
 

package/src/models/components/getcollectionresponse.ts

@@ -13,11 +13,11 @@ import {
   Collection$outboundSchema,
 } from "./collection.js";
 import {
-  CollectionError3,
-  CollectionError3$inboundSchema,
-  CollectionError3$Outbound,
-  CollectionError3$outboundSchema,
-} from "./collectionerror3.js";
+  CollectionError,
+  CollectionError$inboundSchema,
+  CollectionError$Outbound,
+  CollectionError$outboundSchema,
+} from "./collectionerror.js";
 
 export type GetCollectionResponse = {
   collection?: Collection | undefined;
@@ -26,7 +26,7 @@ export type GetCollectionResponse = {
    * An opaque token that represents this particular Collection. To be used for `/feedback` reporting.
    */
   trackingToken?: string | undefined;
-  error?: CollectionError3 | undefined;
+  error?: CollectionError | undefined;
 };
 
 /** @internal */
@@ -38,7 +38,7 @@ export const GetCollectionResponse$inboundSchema: z.ZodType<
   collection: Collection$inboundSchema.optional(),
   rootCollection: Collection$inboundSchema.optional(),
   trackingToken: z.string().optional(),
-  error: CollectionError3$inboundSchema.optional(),
+  error: CollectionError$inboundSchema.optional(),
 });
 
 /** @internal */
@@ -46,7 +46,7 @@ export type GetCollectionResponse$Outbound = {
   collection?: Collection$Outbound | undefined;
   rootCollection?: Collection$Outbound | undefined;
   trackingToken?: string | undefined;
-  error?: CollectionError3$Outbound | undefined;
+  error?: CollectionError$Outbound | undefined;
 };
 
 /** @internal */
@@ -58,7 +58,7 @@ export const GetCollectionResponse$outboundSchema: z.ZodType<
   collection: Collection$outboundSchema.optional(),
   rootCollection: Collection$outboundSchema.optional(),
   trackingToken: z.string().optional(),
-  error: CollectionError3$outboundSchema.optional(),
+  error: CollectionError$outboundSchema.optional(),
 });
 
 /**

package/src/models/components/gleandataerror.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ErrorMessage,
+  ErrorMessage$inboundSchema,
+  ErrorMessage$Outbound,
+  ErrorMessage$outboundSchema,
+} from "./errormessage.js";
+import {
+  InvalidOperatorValueError,
+  InvalidOperatorValueError$inboundSchema,
+  InvalidOperatorValueError$Outbound,
+  InvalidOperatorValueError$outboundSchema,
+} from "./invalidoperatorvalueerror.js";
+
+export type GleanDataError = {
+  /**
+   * Indicates the gmail results could not be fetched due to bad token.
+   */
+  badGmailToken?: boolean | undefined;
+  /**
+   * Indicates the outlook results could not be fetched due to bad token.
+   */
+  badOutlookToken?: boolean | undefined;
+  /**
+   * Indicates results could not be fetched due to invalid operators in the query.
+   */
+  invalidOperators?: Array<InvalidOperatorValueError> | undefined;
+  errorMessages?: Array<ErrorMessage> | undefined;
+};
+
+/** @internal */
+export const GleanDataError$inboundSchema: z.ZodType<
+  GleanDataError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  badGmailToken: z.boolean().optional(),
+  badOutlookToken: z.boolean().optional(),
+  invalidOperators: z.array(InvalidOperatorValueError$inboundSchema).optional(),
+  errorMessages: z.array(ErrorMessage$inboundSchema).optional(),
+});
+
+/** @internal */
+export type GleanDataError$Outbound = {
+  badGmailToken?: boolean | undefined;
+  badOutlookToken?: boolean | undefined;
+  invalidOperators?: Array<InvalidOperatorValueError$Outbound> | undefined;
+  errorMessages?: Array<ErrorMessage$Outbound> | undefined;
+};
+
+/** @internal */
+export const GleanDataError$outboundSchema: z.ZodType<
+  GleanDataError$Outbound,
+  z.ZodTypeDef,
+  GleanDataError
+> = z.object({
+  badGmailToken: z.boolean().optional(),
+  badOutlookToken: z.boolean().optional(),
+  invalidOperators: z.array(InvalidOperatorValueError$outboundSchema)
+    .optional(),
+  errorMessages: z.array(ErrorMessage$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GleanDataError$ {
+  /** @deprecated use `GleanDataError$inboundSchema` instead. */
+  export const inboundSchema = GleanDataError$inboundSchema;
+  /** @deprecated use `GleanDataError$outboundSchema` instead. */
+  export const outboundSchema = GleanDataError$outboundSchema;
+  /** @deprecated use `GleanDataError$Outbound` instead. */
+  export type Outbound = GleanDataError$Outbound;
+}
+
+export function gleanDataErrorToJSON(gleanDataError: GleanDataError): string {
+  return JSON.stringify(GleanDataError$outboundSchema.parse(gleanDataError));
+}
+
+export function gleanDataErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GleanDataError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GleanDataError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GleanDataError' from JSON`,
+  );
+}