@egain/egain-mcp-server 1.0.1

package/src/models/answersresponse.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  ReferenceResponse,
+  ReferenceResponse$zodSchema,
+} from "./referenceresponse.js";
+import { SearchResult, SearchResult$zodSchema } from "./searchresult.js";
+
+/**
+ * Indicates whether the answer was extracted directly from documents or generated by the LLM.
+ */
+export const AnswersResponseAnswerType$zodSchema = z.enum([
+  "certified",
+  "generative",
+]).describe(
+  "Indicates whether the answer was extracted directly from documents or generated by the LLM.",
+);
+
+export type AnswersResponseAnswerType = z.infer<
+  typeof AnswersResponseAnswerType$zodSchema
+>;
+
+export type AnswersResponseAnswer = {
+  answerValue: string;
+  references: Array<ReferenceResponse>;
+  answerType: AnswersResponseAnswerType;
+  relevanceScore: number;
+};
+
+export const AnswersResponseAnswer$zodSchema: z.ZodType<
+  AnswersResponseAnswer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  answerType: AnswersResponseAnswerType$zodSchema,
+  answerValue: z.string(),
+  references: z.array(ReferenceResponse$zodSchema),
+  relevanceScore: z.number(),
+});
+
+/**
+ * The channel where the query originated, e.g., directly from the portal or via a custom integration.
+ */
+export const AnswersResponseType$zodSchema = z.enum([
+  "portal",
+  "custom",
+]).describe(
+  "The channel where the query originated, e.g., directly from the portal or via a custom integration.",
+);
+
+export type AnswersResponseType = z.infer<typeof AnswersResponseType$zodSchema>;
+
+export type AnswersResponseChannel = {
+  type: AnswersResponseType;
+  name?: string | undefined;
+};
+
+export const AnswersResponseChannel$zodSchema: z.ZodType<
+  AnswersResponseChannel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  type: AnswersResponseType$zodSchema,
+});
+
+export type AnswersResponse = {
+  answer: AnswersResponseAnswer;
+  searchResults: Array<SearchResult>;
+  channel?: AnswersResponseChannel | undefined;
+  sessionId: string;
+  eventId?: string | undefined;
+};
+
+export const AnswersResponse$zodSchema: z.ZodType<
+  AnswersResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  answer: z.lazy(() => AnswersResponseAnswer$zodSchema),
+  channel: z.lazy(() => AnswersResponseChannel$zodSchema).optional(),
+  eventId: z.string().optional(),
+  searchResults: z.array(SearchResult$zodSchema),
+  sessionId: z.string(),
+});

package/src/models/article.ts

@@ -0,0 +1,120 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  ArticleAttachment,
+  ArticleAttachment$zodSchema,
+} from "./articleattachment.js";
+import { ArticleType, ArticleType$zodSchema } from "./articletype.js";
+import { BookmarkStatus, BookmarkStatus$zodSchema } from "./bookmarkstatus.js";
+import {
+  ComplianceForArticle,
+  ComplianceForArticle$zodSchema,
+} from "./complianceforarticle.js";
+import { CreatedBy, CreatedBy$zodSchema } from "./createdby.js";
+import {
+  CustomAttribute,
+  CustomAttribute$zodSchema,
+} from "./customattribute.js";
+import { Edition, Edition$zodSchema } from "./edition.js";
+import { LanguageCode, LanguageCode$zodSchema } from "./languagecode.js";
+import { Link, Link$zodSchema } from "./link.js";
+import { ModifiedBy, ModifiedBy$zodSchema } from "./modifiedby.js";
+import { OwnedBy, OwnedBy$zodSchema } from "./ownedby.js";
+import {
+  Personalization,
+  Personalization$zodSchema,
+} from "./personalization.js";
+import {
+  StructuredAuthoringFields,
+  StructuredAuthoringFields$zodSchema,
+} from "./structuredauthoringfields.js";
+import {
+  TopicBreadcrumb,
+  TopicBreadcrumb$zodSchema,
+} from "./topicbreadcrumb.js";
+import { Workflow, Workflow$zodSchema } from "./workflow.js";
+
+/**
+ * Success
+ */
+export type Article = {
+  id: string;
+  additionalInfo?: string | undefined;
+  articleMacro?: string | undefined;
+  articleType?: ArticleType | undefined;
+  articleKeywords?: string | undefined;
+  articleSummary?: string | undefined;
+  attachments?: Array<ArticleAttachment> | undefined;
+  availabilityDate?: string | undefined;
+  availableEditions?: Array<Edition> | undefined;
+  averageRating?: number | undefined;
+  content?: string | undefined;
+  contentText?: string | undefined;
+  createdBy: CreatedBy;
+  modifiedBy?: ModifiedBy | undefined;
+  ownedBy?: OwnedBy | undefined;
+  createdDate?: string | undefined;
+  customAttributes?: Array<CustomAttribute> | undefined;
+  departmentID?: string | undefined;
+  description?: string | undefined;
+  expirationDate?: string | undefined;
+  includeInGenAI?: boolean | undefined;
+  isSubscribed?: boolean | undefined;
+  modifiedDate?: string | undefined;
+  languageCode?: LanguageCode | undefined;
+  link?: Link | undefined;
+  imageURL?: string | undefined;
+  name: string;
+  structuredAuthoringFields?: StructuredAuthoringFields | undefined;
+  articleState?: string | undefined;
+  timesRated?: number | undefined;
+  topicBreadcrumb: Array<TopicBreadcrumb>;
+  versionId?: string | undefined;
+  workflow?: Workflow | undefined;
+  compliance?: ComplianceForArticle | undefined;
+  personalization?: Personalization | undefined;
+  bookmarkStatus?: BookmarkStatus | undefined;
+};
+
+export const Article$zodSchema: z.ZodType<Article, z.ZodTypeDef, unknown> = z
+  .object({
+    additionalInfo: z.string().optional(),
+    articleKeywords: z.string().optional(),
+    articleMacro: z.string().optional(),
+    articleState: z.string().optional(),
+    articleSummary: z.string().optional(),
+    articleType: ArticleType$zodSchema.optional(),
+    attachments: z.array(ArticleAttachment$zodSchema).optional(),
+    availabilityDate: z.string().optional(),
+    availableEditions: z.array(Edition$zodSchema).optional(),
+    averageRating: z.number().optional(),
+    bookmarkStatus: BookmarkStatus$zodSchema.optional(),
+    compliance: ComplianceForArticle$zodSchema.optional(),
+    content: z.string().optional(),
+    contentText: z.string().optional(),
+    createdBy: CreatedBy$zodSchema,
+    createdDate: z.string().optional(),
+    customAttributes: z.array(CustomAttribute$zodSchema).optional(),
+    departmentID: z.string().optional(),
+    description: z.string().optional(),
+    expirationDate: z.string().optional(),
+    id: z.string(),
+    imageURL: z.string().optional(),
+    includeInGenAI: z.boolean().optional(),
+    isSubscribed: z.boolean().optional(),
+    languageCode: LanguageCode$zodSchema.optional(),
+    link: Link$zodSchema.optional(),
+    modifiedBy: ModifiedBy$zodSchema.optional(),
+    modifiedDate: z.string().optional(),
+    name: z.string(),
+    ownedBy: OwnedBy$zodSchema.optional(),
+    personalization: Personalization$zodSchema.optional(),
+    structuredAuthoringFields: StructuredAuthoringFields$zodSchema.optional(),
+    timesRated: z.number().int().optional(),
+    topicBreadcrumb: z.array(TopicBreadcrumb$zodSchema),
+    versionId: z.string().optional(),
+    workflow: Workflow$zodSchema.optional(),
+  }).describe("Success");

package/src/models/articleadditionalattributes.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export const ArticleAdditionalAttributes$zodSchema = z.enum([
+  "articleMacro",
+  "availabilityDate",
+  "availableEditions",
+  "averageRating",
+  "bookmarkStatus",
+  "content",
+  "contentText",
+  "compliance",
+  "timesRated",
+  "createdBy.userName",
+  "modifiedBy.userName",
+  "ownedBy",
+  "ownedBy.userName",
+  "workflow",
+  "all",
+]);
+
+export type ArticleAdditionalAttributes = z.infer<
+  typeof ArticleAdditionalAttributes$zodSchema
+>;

package/src/models/articleattachment.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { Link, Link$zodSchema } from "./link.js";
+
+/**
+ * The type of attachment.
+ */
+export const ArticleAttachmentType$zodSchema = z.enum([
+  "INTERNAL",
+  "EXTERNAL",
+]).describe("The type of attachment.");
+
+export type ArticleAttachmentType = z.infer<
+  typeof ArticleAttachmentType$zodSchema
+>;
+
+export type ArticleAttachment = {
+  id?: string | undefined;
+  name?: string | undefined;
+  size?: number | undefined;
+  type?: ArticleAttachmentType | undefined;
+  link?: Link | undefined;
+};
+
+export const ArticleAttachment$zodSchema: z.ZodType<
+  ArticleAttachment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  link: Link$zodSchema.optional(),
+  name: z.string().optional(),
+  size: z.number().int().optional(),
+  type: ArticleAttachmentType$zodSchema.optional(),
+});

package/src/models/articleresult.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ArticleType, ArticleType$zodSchema } from "./articletype.js";
+import {
+  ComplianceForArticle,
+  ComplianceForArticle$zodSchema,
+} from "./complianceforarticle.js";
+import { CreatedBy, CreatedBy$zodSchema } from "./createdby.js";
+import {
+  CustomAttribute,
+  CustomAttribute$zodSchema,
+} from "./customattribute.js";
+import { LanguageCode, LanguageCode$zodSchema } from "./languagecode.js";
+import { Link, Link$zodSchema } from "./link.js";
+import { ModifiedBy, ModifiedBy$zodSchema } from "./modifiedby.js";
+import { OwnedBy, OwnedBy$zodSchema } from "./ownedby.js";
+import {
+  Personalization,
+  Personalization$zodSchema,
+} from "./personalization.js";
+import {
+  TopicBreadcrumb,
+  TopicBreadcrumb$zodSchema,
+} from "./topicbreadcrumb.js";
+import { Workflow, Workflow$zodSchema } from "./workflow.js";
+
+/**
+ * Article search result, a subset of Article that does not contain content and contentText.
+ */
+export type ArticleResult = {
+  id?: string | undefined;
+  articleType?: ArticleType | undefined;
+  articleKeywords?: string | undefined;
+  articleSummary?: string | undefined;
+  averageRating?: number | undefined;
+  createdBy?: CreatedBy | undefined;
+  modifiedBy?: ModifiedBy | undefined;
+  ownedBy?: OwnedBy | undefined;
+  createdDate?: string | undefined;
+  customAttributes?: Array<CustomAttribute> | undefined;
+  description?: string | undefined;
+  hasAttachments?: boolean | undefined;
+  isSubscribed?: boolean | undefined;
+  modifiedDate?: string | undefined;
+  languageCode?: LanguageCode | undefined;
+  link?: Link | undefined;
+  imageURL?: string | undefined;
+  name?: string | undefined;
+  timesRated?: number | undefined;
+  topicBreadcrumb?: Array<TopicBreadcrumb> | undefined;
+  versionId?: string | undefined;
+  workflow?: Workflow | undefined;
+  compliance?: ComplianceForArticle | undefined;
+  personalization?: Personalization | undefined;
+};
+
+export const ArticleResult$zodSchema: z.ZodType<
+  ArticleResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  articleKeywords: z.string().optional(),
+  articleSummary: z.string().optional(),
+  articleType: ArticleType$zodSchema.optional(),
+  averageRating: z.number().optional(),
+  compliance: ComplianceForArticle$zodSchema.optional(),
+  createdBy: CreatedBy$zodSchema.optional(),
+  createdDate: z.string().optional(),
+  customAttributes: z.array(CustomAttribute$zodSchema).optional(),
+  description: z.string().optional(),
+  hasAttachments: z.boolean().optional(),
+  id: z.string().optional(),
+  imageURL: z.string().optional(),
+  isSubscribed: z.boolean().optional(),
+  languageCode: LanguageCode$zodSchema.optional(),
+  link: Link$zodSchema.optional(),
+  modifiedBy: ModifiedBy$zodSchema.optional(),
+  modifiedDate: z.string().optional(),
+  name: z.string().optional(),
+  ownedBy: OwnedBy$zodSchema.optional(),
+  personalization: Personalization$zodSchema.optional(),
+  timesRated: z.number().int().optional(),
+  topicBreadcrumb: z.array(TopicBreadcrumb$zodSchema).optional(),
+  versionId: z.string().optional(),
+  workflow: Workflow$zodSchema.optional(),
+}).describe(
+  "Article search result, a subset of Article that does not contain content and contentText.",
+);

package/src/models/articleresults.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ArticleResult, ArticleResult$zodSchema } from "./articleresult.js";
+import { PaginationInfo, PaginationInfo$zodSchema } from "./paginationinfo.js";
+
+/**
+ * One or more instances of an Article result.
+ */
+export type ArticleResults = {
+  articles?: Array<ArticleResult> | undefined;
+  paginationInfo?: PaginationInfo | undefined;
+};
+
+export const ArticleResults$zodSchema: z.ZodType<
+  ArticleResults,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  articles: z.array(ArticleResult$zodSchema).optional(),
+  paginationInfo: PaginationInfo$zodSchema.optional(),
+}).describe("One or more instances of an Article result.");

package/src/models/articlesearchresult.ts

@@ -0,0 +1,139 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  AdditionalSnippets,
+  AdditionalSnippets$zodSchema,
+} from "./additionalsnippets.js";
+import { Tags, Tags$zodSchema } from "./tags.js";
+import {
+  TopicBreadcrumb,
+  TopicBreadcrumb$zodSchema,
+} from "./topicbreadcrumb.js";
+
+/**
+ * Format of the source document (HTML, DOCX, PPTX or PDF).
+ */
+export const ArticleSearchResultDocType$zodSchema = z.enum([
+  "HTML",
+  "DOCX",
+  "PDF",
+  "PPTX",
+]).describe("Format of the source document (HTML, DOCX, PPTX or PDF).");
+
+export type ArticleSearchResultDocType = z.infer<
+  typeof ArticleSearchResultDocType$zodSchema
+>;
+
+/**
+ * The source type.
+ */
+export const ArticleSearchResultSource$zodSchema = z.enum([
+  "eGain Article",
+  "eGain Attachment",
+]).describe("The source type.");
+
+export type ArticleSearchResultSource = z.infer<
+  typeof ArticleSearchResultSource$zodSchema
+>;
+
+/**
+ * The custom attribute's type.
+ */
+export const ArticleSearchResultType$zodSchema = z.enum([
+  "STRING",
+  "INTEGER",
+  "BOOLEAN",
+  "DATETIME",
+]).describe("The custom attribute's type.");
+
+export type ArticleSearchResultType = z.infer<
+  typeof ArticleSearchResultType$zodSchema
+>;
+
+export type ArticleSearchResultCustomAttribute = {
+  name?: string | undefined;
+  value?: Array<string> | undefined;
+  type?: ArticleSearchResultType | undefined;
+};
+
+export const ArticleSearchResultCustomAttribute$zodSchema: z.ZodType<
+  ArticleSearchResultCustomAttribute,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  type: ArticleSearchResultType$zodSchema.optional(),
+  value: z.array(z.string()).optional(),
+});
+
+/**
+ * The type of the Article and its attributes.
+ */
+export type ArticleTypeAttributes = {
+  typeName?: string | undefined;
+  articleTypeId?: string | undefined;
+};
+
+export const ArticleTypeAttributes$zodSchema: z.ZodType<
+  ArticleTypeAttributes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  articleTypeId: z.string().optional(),
+  typeName: z.string().optional(),
+}).describe("The type of the Article and its attributes.");
+
+/**
+ * Represents a single document or snippet returned by search, along with its metadata and relevance score.
+ */
+export type ArticleSearchResult = {
+  id: string;
+  name: string;
+  docType: ArticleSearchResultDocType;
+  docName?: string | undefined;
+  source: ArticleSearchResultSource;
+  customAttributes?: Array<ArticleSearchResultCustomAttribute> | undefined;
+  snippet?: string | undefined;
+  keywordSnippet?: string | undefined;
+  additionalSnippets?: Array<AdditionalSnippets> | undefined;
+  additionalSnippetCount?: number | undefined;
+  contextualSummary?: string | undefined;
+  modifiedDate?: string | undefined;
+  headerPath?: string | undefined;
+  topicBreadcrumb: Array<TopicBreadcrumb>;
+  tagCategories?: Array<Tags> | undefined;
+  articleTypeAttributes?: ArticleTypeAttributes | undefined;
+  relevanceScore: number;
+};
+
+export const ArticleSearchResult$zodSchema: z.ZodType<
+  ArticleSearchResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  additionalSnippetCount: z.number().int().optional(),
+  additionalSnippets: z.array(AdditionalSnippets$zodSchema).optional(),
+  articleTypeAttributes: z.lazy(() => ArticleTypeAttributes$zodSchema)
+    .optional(),
+  contextualSummary: z.string().optional(),
+  customAttributes: z.array(
+    z.lazy(() => ArticleSearchResultCustomAttribute$zodSchema),
+  ).optional(),
+  docName: z.string().optional(),
+  docType: ArticleSearchResultDocType$zodSchema,
+  headerPath: z.string().optional(),
+  id: z.string(),
+  keywordSnippet: z.string().optional(),
+  modifiedDate: z.string().optional(),
+  name: z.string(),
+  relevanceScore: z.number(),
+  snippet: z.string().optional(),
+  source: ArticleSearchResultSource$zodSchema,
+  tagCategories: z.array(Tags$zodSchema).optional(),
+  topicBreadcrumb: z.array(TopicBreadcrumb$zodSchema),
+}).describe(
+  "Represents a single document or snippet returned by search, along with its metadata and relevance score.",
+);

package/src/models/articletype.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * Indicates the article category name.
+ */
+export const TypeName$zodSchema = z.enum([
+  "General",
+  "Guided Help",
+  "Data Link",
+  "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;
+  useStructuredAuthoring?: boolean | undefined;
+  articleTypeId?: string | undefined;
+};
+
+export const ArticleType$zodSchema: z.ZodType<
+  ArticleType,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  articleCategoryId: z.number().int().optional(),
+  articleTypeId: z.string().optional(),
+  typeName: TypeName$zodSchema.optional(),
+  useStructuredAuthoring: z.boolean().optional(),
+}).describe("The type of the Article and its attributes.");

package/src/models/attachmentforcreatesuggestion.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * This schema contains the definition of an Attachment.
+ */
+export type AttachmentForCreateSuggestion = { altId?: string | undefined };
+
+export const AttachmentForCreateSuggestion$zodSchema: z.ZodType<
+  AttachmentForCreateSuggestion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  altId: z.string().optional(),
+}).describe("This schema contains the definition of an Attachment.");

package/src/models/bookmarkstatus.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  FolderBreadcrumb,
+  FolderBreadcrumb$zodSchema,
+} from "./folderbreadcrumb.js";
+
+/**
+ * Article Bookmark Status
+ */
+export type BookmarkStatus = {
+  isBookmarked: boolean;
+  bookmarkID?: number | undefined;
+  folderBreadcrumb?: FolderBreadcrumb | undefined;
+};
+
+export const BookmarkStatus$zodSchema: z.ZodType<
+  BookmarkStatus,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bookmarkID: z.number().int().optional(),
+  folderBreadcrumb: FolderBreadcrumb$zodSchema.optional(),
+  isBookmarked: z.boolean(),
+}).describe("Article Bookmark Status");

package/src/models/complianceforarticle.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * The start date for the Article.
+ */
+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.");
+
+/**
+ * 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.");
+
+/**
+ * This schema contains the compliance details for an Article.
+ */
+export type ComplianceForArticle = {
+  startDate?: StartDateDateAndTime | undefined;
+  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.");

package/src/models/createdby.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type CreatedBy = {
+  id?: string | undefined;
+  userName?: string | undefined;
+  firstName?: string | undefined;
+  middleName?: string | undefined;
+  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(),
+  });