@egain/egain-mcp-server 1.0.26 → 1.1.0

package/src/models/articleresults.ts

@@ -14,11 +14,7 @@ export type ArticleResults = {
   paginationInfo?: PaginationInfo | undefined;
 };
 
-export const ArticleResults$zodSchema: z.ZodType<
-  ArticleResults,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const ArticleResults$zodSchema: z.ZodType<ArticleResults> = z.object({
   articles: z.array(ArticleResult$zodSchema).optional(),
   paginationInfo: PaginationInfo$zodSchema.optional(),
 }).describe("One or more instances of an Article result.");

package/src/models/articletype.ts

@@ -4,40 +4,19 @@
 
 import * as z from "zod";
 
-/**
- * Indicates the article category name.
- */
-export const TypeName$zodSchema = z.enum([
-  "General",
-  "Guided Help",
-  "Data Link",
-  "PDF Content",
-  "Topic Home",
-  "Suggestion",
-  "Virtual Assistant Action",
-  "Rich Message",
-  "Library Content",
-]).describe("Indicates the article category name.");
-
-export type TypeName = z.infer<typeof TypeName$zodSchema>;
-
 /**
  * The type of the Article and its attributes.
  */
 export type ArticleType = {
   articleCategoryId?: number | undefined;
-  typeName?: TypeName | undefined;
+  typeName?: string | undefined;
   useStructuredAuthoring?: boolean | undefined;
   articleTypeId?: string | undefined;
 };
 
-export const ArticleType$zodSchema: z.ZodType<
-  ArticleType,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  articleCategoryId: z.number().int().optional(),
+export const ArticleType$zodSchema: z.ZodType<ArticleType> = z.object({
+  articleCategoryId: z.int().optional(),
   articleTypeId: z.string().optional(),
-  typeName: TypeName$zodSchema.optional(),
+  typeName: z.string().optional(),
   useStructuredAuthoring: z.boolean().optional(),
 }).describe("The type of the Article and its attributes.");

package/src/models/attachmentforcreatesuggestion.ts

@@ -10,9 +10,7 @@ import * as z from "zod";
 export type AttachmentForCreateSuggestion = { altId?: string | undefined };
 
 export const AttachmentForCreateSuggestion$zodSchema: z.ZodType<
-  AttachmentForCreateSuggestion,
-  z.ZodTypeDef,
-  unknown
+  AttachmentForCreateSuggestion
 > = z.object({
   altId: z.string().optional(),
 }).describe("This schema contains the definition of an Attachment.");

package/src/models/bookmarkstatus.ts

@@ -17,12 +17,8 @@ export type BookmarkStatus = {
   folderBreadcrumb?: FolderBreadcrumb | undefined;
 };
 
-export const BookmarkStatus$zodSchema: z.ZodType<
-  BookmarkStatus,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  bookmarkID: z.number().int().optional(),
+export const BookmarkStatus$zodSchema: z.ZodType<BookmarkStatus> = z.object({
+  bookmarkID: z.int().optional(),
   folderBreadcrumb: FolderBreadcrumb$zodSchema.optional(),
   isBookmarked: z.boolean(),
 }).describe("Article Bookmark Status");

package/src/models/complianceforarticle.ts

@@ -9,26 +9,20 @@ import * as z from "zod";
  */
 export type StartDateDateAndTime = { date: string };
 
-export const StartDateDateAndTime$zodSchema: z.ZodType<
-  StartDateDateAndTime,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  date: z.string().datetime({ offset: true }),
-}).describe("The start date for the Article.");
+export const StartDateDateAndTime$zodSchema: z.ZodType<StartDateDateAndTime> = z
+  .object({
+    date: z.iso.datetime({ offset: true }),
+  }).describe("The start date for the Article.");
 
 /**
  * The end date for the Article.
  */
 export type DueDateDateAndTime = { date: string };
 
-export const DueDateDateAndTime$zodSchema: z.ZodType<
-  DueDateDateAndTime,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  date: z.string().datetime({ offset: true }),
-}).describe("The end date for the Article.");
+export const DueDateDateAndTime$zodSchema: z.ZodType<DueDateDateAndTime> = z
+  .object({
+    date: z.iso.datetime({ offset: true }),
+  }).describe("The end date for the Article.");
 
 /**
  * This schema contains the compliance details for an Article.
@@ -38,11 +32,8 @@ export type ComplianceForArticle = {
   dueDate?: DueDateDateAndTime | undefined;
 };
 
-export const ComplianceForArticle$zodSchema: z.ZodType<
-  ComplianceForArticle,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  dueDate: z.lazy(() => DueDateDateAndTime$zodSchema).optional(),
-  startDate: z.lazy(() => StartDateDateAndTime$zodSchema).optional(),
-}).describe("This schema contains the compliance details for an Article.");
+export const ComplianceForArticle$zodSchema: z.ZodType<ComplianceForArticle> = z
+  .object({
+    dueDate: z.lazy(() => DueDateDateAndTime$zodSchema).optional(),
+    startDate: z.lazy(() => StartDateDateAndTime$zodSchema).optional(),
+  }).describe("This schema contains the compliance details for an Article.");

package/src/models/createdby.ts

@@ -12,11 +12,10 @@ export type CreatedBy = {
   lastName?: string | undefined;
 };
 
-export const CreatedBy$zodSchema: z.ZodType<CreatedBy, z.ZodTypeDef, unknown> =
-  z.object({
-    firstName: z.string().optional(),
-    id: z.string().optional(),
-    lastName: z.string().optional(),
-    middleName: z.string().optional(),
-    userName: z.string().optional(),
-  });
+export const CreatedBy$zodSchema: z.ZodType<CreatedBy> = z.object({
+  firstName: z.string().optional(),
+  id: z.string().optional(),
+  lastName: z.string().optional(),
+  middleName: z.string().optional(),
+  userName: z.string().optional(),
+});

package/src/models/createsuggestion.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
 import {
   AttachmentForCreateSuggestion,
   AttachmentForCreateSuggestion$zodSchema,
@@ -20,9 +21,7 @@ export type RelatedArticleForCreateUpdateDeleteSuggestion = {
 };
 
 export const RelatedArticleForCreateUpdateDeleteSuggestion$zodSchema: z.ZodType<
-  RelatedArticleForCreateUpdateDeleteSuggestion,
-  z.ZodTypeDef,
-  unknown
+  RelatedArticleForCreateUpdateDeleteSuggestion
 > = z.object({
   id: z.string().optional(),
 }).describe("The Article that the Suggestion was created for.");
@@ -34,17 +33,48 @@ export type Attachments = {
   attachment?: Array<AttachmentForCreateSuggestion> | undefined;
 };
 
-export const Attachments$zodSchema: z.ZodType<
-  Attachments,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const Attachments$zodSchema: z.ZodType<Attachments> = z.object({
   attachment: z.array(AttachmentForCreateSuggestion$zodSchema).optional(),
 }).describe("Details of Attachments for the Suggestion.");
 
 /**
  * The code of the language.
  */
+export const Code = {
+  EnUS: "en-US",
+  EnGB: "en-GB",
+  FRFR: "fr-FR",
+  ESES: "es-ES",
+  ITIT: "it-IT",
+  DEDE: "de-DE",
+  NLNL: "nl-NL",
+  PtBR: "pt-BR",
+  PTPT: "pt-PT",
+  DaDK: "da-DK",
+  SvSE: "sv-SE",
+  RURU: "ru-RU",
+  ZhCN: "zh-CN",
+  JaJP: "ja-JP",
+  KoKR: "ko-KR",
+  DeAT: "de-AT",
+  THTH: "th-TH",
+  ViVN: "vi-VN",
+  IDID: "id-ID",
+  MsMY: "ms-MY",
+  FilPH: "fil-PH",
+  FrCA: "fr-CA",
+  HiIN: "hi-IN",
+  UkUA: "uk-UA",
+  BGBG: "bg-BG",
+  SKSK: "sk-SK",
+  SlSI: "sl-SI",
+  SrRS: "sr-RS",
+} as const;
+/**
+ * The code of the language.
+ */
+export type Code = ClosedEnum<typeof Code>;
+
 export const Code$zodSchema = z.enum([
   "en-US",
   "en-GB",
@@ -76,19 +106,14 @@ export const Code$zodSchema = z.enum([
   "sr-RS",
 ]).describe("The code of the language.");
 
-export type Code = z.infer<typeof Code$zodSchema>;
-
 /**
  * The knowledge base language in which the Suggestion is created.
  */
 export type Language = { code: Code };
 
-export const Language$zodSchema: z.ZodType<Language, z.ZodTypeDef, unknown> = z
-  .object({
-    code: Code$zodSchema,
-  }).describe(
-    "The knowledge base language in which the Suggestion is created.",
-  );
+export const Language$zodSchema: z.ZodType<Language> = z.object({
+  code: Code$zodSchema,
+}).describe("The knowledge base language in which the Suggestion is created.");
 
 /**
  * This schema contains information about a Suggestion.
@@ -103,18 +128,16 @@ export type CreateSuggestion = {
   customAttributes?: Array<CustomAttribute> | undefined;
 };
 
-export const CreateSuggestion$zodSchema: z.ZodType<
-  CreateSuggestion,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  attachments: z.lazy(() => Attachments$zodSchema).optional(),
-  content: z.string(),
-  customAttributes: z.array(CustomAttribute$zodSchema).optional(),
-  description: z.string().optional(),
-  feedbackArticle: z.lazy(() =>
-    RelatedArticleForCreateUpdateDeleteSuggestion$zodSchema
-  ).optional(),
-  language: z.lazy(() => Language$zodSchema),
-  name: z.string(),
-}).describe("This schema contains information about a Suggestion.");
+export const CreateSuggestion$zodSchema: z.ZodType<CreateSuggestion> = z.object(
+  {
+    attachments: z.lazy(() => Attachments$zodSchema).optional(),
+    content: z.string(),
+    customAttributes: z.array(CustomAttribute$zodSchema).optional(),
+    description: z.string().optional(),
+    feedbackArticle: z.lazy(() =>
+      RelatedArticleForCreateUpdateDeleteSuggestion$zodSchema
+    ).optional(),
+    language: z.lazy(() => Language$zodSchema),
+    name: z.string(),
+  },
+).describe("This schema contains information about a Suggestion.");

package/src/models/customattribute.ts

@@ -3,10 +3,22 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
 
 /**
  * The custom attribute's type.
  */
+export const CustomAttributeType = {
+  String: "STRING",
+  Integer: "INTEGER",
+  Boolean: "BOOLEAN",
+  Datetime: "DATETIME",
+} as const;
+/**
+ * The custom attribute's type.
+ */
+export type CustomAttributeType = ClosedEnum<typeof CustomAttributeType>;
+
 export const CustomAttributeType$zodSchema = z.enum([
   "STRING",
   "INTEGER",
@@ -14,19 +26,13 @@ export const CustomAttributeType$zodSchema = z.enum([
   "DATETIME",
 ]).describe("The custom attribute's type.");
 
-export type CustomAttributeType = z.infer<typeof CustomAttributeType$zodSchema>;
-
 export type CustomAttribute = {
   name?: string | undefined;
   value?: Array<string> | undefined;
   type?: CustomAttributeType | undefined;
 };
 
-export const CustomAttribute$zodSchema: z.ZodType<
-  CustomAttribute,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const CustomAttribute$zodSchema: z.ZodType<CustomAttribute> = z.object({
   name: z.string().optional(),
   type: CustomAttributeType$zodSchema.optional(),
   value: z.array(z.string()).optional(),

package/src/models/department.ts

@@ -6,11 +6,7 @@ import * as z from "zod";
 
 export type Department = { id?: string | undefined; name?: string | undefined };
 
-export const Department$zodSchema: z.ZodType<
-  Department,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const Department$zodSchema: z.ZodType<Department> = z.object({
   id: z.string().optional(),
   name: z.string().optional(),
 });

package/src/models/edition.ts

@@ -10,11 +10,7 @@ import { Link, Link$zodSchema } from "./link.js";
  */
 export type PublishProfile = { id: string; name: string };
 
-export const PublishProfile$zodSchema: z.ZodType<
-  PublishProfile,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const PublishProfile$zodSchema: z.ZodType<PublishProfile> = z.object({
   id: z.string(),
   name: z.string(),
 }).describe("The publish view associated with this edition.");
@@ -30,11 +26,10 @@ export type Edition = {
   link?: Link | undefined;
 };
 
-export const Edition$zodSchema: z.ZodType<Edition, z.ZodTypeDef, unknown> = z
-  .object({
-    id: z.string().optional(),
-    isContentEdition: z.boolean().optional(),
-    link: Link$zodSchema.optional(),
-    name: z.string().optional(),
-    publishProfile: z.lazy(() => PublishProfile$zodSchema).optional(),
-  }).describe("This schema contains information about an article edition.");
+export const Edition$zodSchema: z.ZodType<Edition> = z.object({
+  id: z.string().optional(),
+  isContentEdition: z.boolean().optional(),
+  link: Link$zodSchema.optional(),
+  name: z.string().optional(),
+  publishProfile: z.lazy(() => PublishProfile$zodSchema).optional(),
+}).describe("This schema contains information about an article edition.");

package/src/models/errors/sdkvalidationerror.ts

@@ -37,61 +37,6 @@ export class SDKValidationError extends Error {
   }
 }
 
-export function formatZodError(err: z.ZodError, level = 0): string {
-  let pre = "  ".repeat(level);
-  pre = level > 0 ? `│${pre}` : pre;
-  pre += " ".repeat(level);
-
-  let message = "";
-  const append = (str: string) => (message += `\n${pre}${str}`);
-
-  const len = err.issues.length;
-  const headline = len === 1 ? `${len} issue found` : `${len} issues found`;
-
-  if (len) {
-    append(`┌ ${headline}:`);
-  }
-
-  for (const issue of err.issues) {
-    let path = issue.path.join(".");
-    path = path ? `<root>.${path}` : "<root>";
-    append(`│ • [${path}]: ${issue.message} (${issue.code})`);
-    switch (issue.code) {
-      case "invalid_literal":
-      case "invalid_type": {
-        append(`│     Want: ${issue.expected}`);
-        append(`│      Got: ${issue.received}`);
-        break;
-      }
-      case "unrecognized_keys": {
-        append(`│     Keys: ${issue.keys.join(", ")}`);
-        break;
-      }
-      case "invalid_enum_value": {
-        append(`│     Allowed: ${issue.options.join(", ")}`);
-        append(`│         Got: ${issue.received}`);
-        break;
-      }
-      case "invalid_union_discriminator": {
-        append(`│     Allowed: ${issue.options.join(", ")}`);
-        break;
-      }
-      case "invalid_union": {
-        const len = issue.unionErrors.length;
-        append(
-          `│   ✖︎ Attemped to deserialize into one of ${len} union members:`,
-        );
-        issue.unionErrors.forEach((err, i) => {
-          append(`│   ✖︎ Member ${i + 1} of ${len}`);
-          append(`${formatZodError(err, level + 1)}`);
-        });
-      }
-    }
-  }
-
-  if (err.issues.length) {
-    append(`└─*`);
-  }
-
-  return message.slice(1);
+export function formatZodError(err: z.ZodError): string {
+  return z.prettifyError(err);
 }

package/src/models/folderbreadcrumb.ts

@@ -12,10 +12,8 @@ export type FolderBreadcrumb = {
   folderSummary?: Array<FolderSummary> | undefined;
 };
 
-export const FolderBreadcrumb$zodSchema: z.ZodType<
-  FolderBreadcrumb,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  folderSummary: z.array(FolderSummary$zodSchema).optional(),
-}).describe("This schema contains one or more FolderSummary instances.");
+export const FolderBreadcrumb$zodSchema: z.ZodType<FolderBreadcrumb> = z.object(
+  {
+    folderSummary: z.array(FolderSummary$zodSchema).optional(),
+  },
+).describe("This schema contains one or more FolderSummary instances.");

package/src/models/foldersummary.ts

@@ -14,12 +14,8 @@ export type FolderSummary = {
   link?: SchemasLink | undefined;
 };
 
-export const FolderSummary$zodSchema: z.ZodType<
-  FolderSummary,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  id: z.number().int().optional(),
+export const FolderSummary$zodSchema: z.ZodType<FolderSummary> = z.object({
+  id: z.int().optional(),
   link: SchemasLink$zodSchema.optional(),
   name: z.string().optional(),
 }).describe(

package/src/models/getannouncementarticlesop.ts

@@ -4,6 +4,10 @@
 
 import * as z from "zod";
 import { AcceptLanguage, AcceptLanguage$zodSchema } from "./acceptlanguage.js";
+import {
+  ArticleResultAdditionalAttributes,
+  ArticleResultAdditionalAttributes$zodSchema,
+} from "./articleresultadditionalattributes.js";
 import { ArticleResults, ArticleResults$zodSchema } from "./articleresults.js";
 import {
   LanguageQueryParameter,
@@ -16,9 +20,15 @@ import {
 import { WSErrorCommon, WSErrorCommon$zodSchema } from "./wserrorcommon.js";
 
 export type GetAnnouncementArticlesRequest = {
+  xEgainActivityId?: string | undefined;
+  xExtIntegrationId?: string | undefined;
+  xExtInteractionId?: string | undefined;
   acceptLanguage?: AcceptLanguage | undefined;
   portalID: string;
   dollarFilterTags?: string | undefined;
+  articleResultAdditionalAttributes?:
+    | Array<ArticleResultAdditionalAttributes>
+    | undefined;
   workflowMilestone?: WorkflowMilestone | undefined;
   Dollar_lang?: LanguageQueryParameter | undefined;
   Dollar_pagenum?: number | undefined;
@@ -26,18 +36,21 @@ export type GetAnnouncementArticlesRequest = {
 };
 
 export const GetAnnouncementArticlesRequest$zodSchema: z.ZodType<
-  GetAnnouncementArticlesRequest,
-  z.ZodTypeDef,
-  unknown
+  GetAnnouncementArticlesRequest
 > = z.object({
-  Dollar_lang: LanguageQueryParameter$zodSchema.default("en-US"),
-  Dollar_pagenum: z.number().int().default(1).describe(
+  Dollar_lang: LanguageQueryParameter$zodSchema.optional(),
+  Dollar_pagenum: z.int().default(1).describe(
     "Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.",
   ),
-  Dollar_pagesize: z.number().int().default(10).describe(
+  Dollar_pagesize: z.int().default(10).describe(
     "Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.",
   ),
   acceptLanguage: AcceptLanguage$zodSchema.default("en-US"),
+  articleResultAdditionalAttributes: z.array(
+    ArticleResultAdditionalAttributes$zodSchema,
+  ).describe(
+    "The attributes of an Article to be returned *in addition to* the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.\n\n#### Default Attributes\nThese Article attributes are always returned:\n\n| Name | Description \n| ---- | -----------\n| id | The ID of the Article.\n| name  | The name of the Article.\n| articleType | The Article Type and its attributes.\n| createdBy | The ID, first name, middle name and last name of the user that created the Article.\n| createdDate | The date that the Article was created.\n| hasAttachments | True: The Article has one or more attachments.<br>False: The Article does not have any attachments.\n| languageCode | The language code of the Article language. \n| modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article.\n| modifiedDate | The date that the Article was last modified on.\n| link | The link object, used to retrieve the details of the Article.\n| versionId | The ID of the Article version that is returned.\n",
+  ).optional(),
   dollarFilterTags: z.string().describe(
     "A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.<br><br>Tag IDs and Tag Group IDs can be mixed together.",
   ).optional(),
@@ -45,24 +58,22 @@ export const GetAnnouncementArticlesRequest$zodSchema: z.ZodType<
     "The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.",
   ),
   workflowMilestone: WorkflowMilestone$zodSchema.optional(),
+  xEgainActivityId: z.string().describe(
+    "A unique numeric interaction identifier from eGain.",
+  ).optional(),
+  xExtIntegrationId: z.string().describe(
+    "The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.*",
+  ).optional(),
+  xExtInteractionId: z.string().describe(
+    "A unique interaction identifier from other CRM applications.<br><br>*Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.*",
+  ).optional(),
 });
 
-export type GetAnnouncementArticlesResponse = {
-  ContentType: string;
-  StatusCode: number;
-  RawResponse: Response;
-  ArticleResults?: ArticleResults | undefined;
-  WSErrorCommon?: WSErrorCommon | undefined;
-};
+export type GetAnnouncementArticlesResponse = WSErrorCommon | ArticleResults;
 
 export const GetAnnouncementArticlesResponse$zodSchema: z.ZodType<
-  GetAnnouncementArticlesResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  ArticleResults: ArticleResults$zodSchema.optional(),
-  ContentType: z.string(),
-  RawResponse: z.instanceof(Response),
-  StatusCode: z.number().int(),
-  WSErrorCommon: WSErrorCommon$zodSchema.optional(),
-});
+  GetAnnouncementArticlesResponse
+> = z.union([
+  WSErrorCommon$zodSchema,
+  ArticleResults$zodSchema,
+]);