@egain/egain-mcp-server 1.0.1

package/src/models/createsuggestion.ts

@@ -0,0 +1,108 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  AttachmentForCreateSuggestion,
+  AttachmentForCreateSuggestion$zodSchema,
+} from "./attachmentforcreatesuggestion.js";
+import {
+  CustomAttribute,
+  CustomAttribute$zodSchema,
+} from "./customattribute.js";
+
+/**
+ * The Article that the Suggestion was created for.
+ */
+export type RelatedArticleForCreateUpdateDeleteSuggestion = {
+  id?: string | undefined;
+};
+
+export const RelatedArticleForCreateUpdateDeleteSuggestion$zodSchema: z.ZodType<
+  RelatedArticleForCreateUpdateDeleteSuggestion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+}).describe("The Article that the Suggestion was created for.");
+
+/**
+ * Details of Attachments for the Suggestion.
+ */
+export type Attachments = {
+  attachment?: Array<AttachmentForCreateSuggestion> | undefined;
+};
+
+export const Attachments$zodSchema: z.ZodType<
+  Attachments,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  attachment: z.array(AttachmentForCreateSuggestion$zodSchema).optional(),
+}).describe("Details of Attachments for the Suggestion.");
+
+/**
+ * The code of the language.
+ */
+export const Code$zodSchema = z.enum([
+  "en-US",
+  "en-GB",
+  "fr-FR",
+  "es-ES",
+  "it-IT",
+  "de-DE",
+  "nl-NL",
+  "pt-BR",
+  "pt-PT",
+  "da-DK",
+  "sv-SE",
+  "ru-RU",
+  "fr-CA",
+  "zh-CN",
+  "ja-JP",
+  "ko-KR",
+]).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.",
+  );
+
+/**
+ * This schema contains information about a Suggestion.
+ */
+export type CreateSuggestion = {
+  name: string;
+  description?: string | undefined;
+  content: string;
+  feedbackArticle?: RelatedArticleForCreateUpdateDeleteSuggestion | undefined;
+  attachments?: Attachments | undefined;
+  language: Language;
+  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.");

package/src/models/customattribute.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * The custom attribute's type.
+ */
+export const CustomAttributeType$zodSchema = z.enum([
+  "STRING",
+  "INTEGER",
+  "BOOLEAN",
+  "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({
+  name: z.string().optional(),
+  type: CustomAttributeType$zodSchema.optional(),
+  value: z.array(z.string()).optional(),
+});

package/src/models/department.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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({
+  id: z.string().optional(),
+  name: z.string().optional(),
+});

package/src/models/edition.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { Link, Link$zodSchema } from "./link.js";
+
+/**
+ * The publish view associated with this edition.
+ */
+export type PublishProfile = { id: string; name: string };
+
+export const PublishProfile$zodSchema: z.ZodType<
+  PublishProfile,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+}).describe("The publish view associated with this edition.");
+
+/**
+ * This schema contains information about an article edition.
+ */
+export type Edition = {
+  id?: string | undefined;
+  name?: string | undefined;
+  isContentEdition?: boolean | undefined;
+  publishProfile?: PublishProfile | undefined;
+  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.");

package/src/models/errors/apierror.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export class APIError extends Error {
+  constructor(
+    message: string,
+    public readonly httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(
+      `${message}: Status ${httpMeta.response.status} Content-Type ${
+        httpMeta.response.headers.get("content-type") || ""
+      } Body: ${httpMeta.body}`,
+    );
+    this.name = "APIError";
+  }
+}

package/src/models/errors/httpclienterrors.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Base class for all HTTP errors.
+ */
+export class HTTPClientError extends Error {
+  /** The underlying cause of the error. */
+  override readonly cause: unknown;
+  override name = "HTTPClientError";
+  constructor(message: string, opts?: { cause?: unknown }) {
+    let msg = message;
+    if (opts?.cause) {
+      msg += `: ${opts.cause}`;
+    }
+
+    super(msg, opts);
+    // In older runtimes, the cause field would not have been assigned through
+    // the super() call.
+    if (typeof this.cause === "undefined") {
+      this.cause = opts?.cause;
+    }
+  }
+}
+
+/**
+ * An error to capture unrecognised or unexpected errors when making HTTP calls.
+ */
+export class UnexpectedClientError extends HTTPClientError {
+  override name = "UnexpectedClientError";
+}
+
+/**
+ * An error that is raised when any inputs used to create a request are invalid.
+ */
+export class InvalidRequestError extends HTTPClientError {
+  override name = "InvalidRequestError";
+}
+
+/**
+ * An error that is raised when a HTTP request was aborted by the client error.
+ */
+export class RequestAbortedError extends HTTPClientError {
+  override readonly name = "RequestAbortedError";
+}
+
+/**
+ * An error that is raised when a HTTP request timed out due to an AbortSignal
+ * signal timeout.
+ */
+export class RequestTimeoutError extends HTTPClientError {
+  override readonly name = "RequestTimeoutError";
+}
+
+/**
+ * An error that is raised when a HTTP client is unable to make a request to
+ * a server.
+ */
+export class ConnectionError extends HTTPClientError {
+  override readonly name = "ConnectionError";
+}

package/src/models/errors/sdkvalidationerror.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export class SDKValidationError extends Error {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(message: string, cause: unknown, rawValue: unknown) {
+    super(`${message}: ${cause}`);
+    this.name = "SDKValidationError";
+    this.cause = cause;
+    this.rawValue = rawValue;
+    this.rawMessage = message;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}
+
+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);
+}

package/src/models/folderbreadcrumb.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { FolderSummary, FolderSummary$zodSchema } from "./foldersummary.js";
+
+/**
+ * This schema contains one or more FolderSummary instances.
+ */
+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.");

package/src/models/foldersummary.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { SchemasLink, SchemasLink$zodSchema } from "./schemaslink.js";
+
+/**
+ * This schema contains the topic ID and name of the Folder. This is used by FolderBreadcrumb.
+ */
+export type FolderSummary = {
+  id?: number | undefined;
+  name?: string | undefined;
+  link?: SchemasLink | undefined;
+};
+
+export const FolderSummary$zodSchema: z.ZodType<
+  FolderSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int().optional(),
+  link: SchemasLink$zodSchema.optional(),
+  name: z.string().optional(),
+}).describe(
+  "This schema contains the topic ID and name of the Folder. This is used by FolderBreadcrumb.",
+);

package/src/models/getannouncementarticlesop.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { AcceptLanguage, AcceptLanguage$zodSchema } from "./acceptlanguage.js";
+import { ArticleResults, ArticleResults$zodSchema } from "./articleresults.js";
+import {
+  LanguageQueryParameter,
+  LanguageQueryParameter$zodSchema,
+} from "./languagequeryparameter.js";
+import {
+  WorkflowMilestone,
+  WorkflowMilestone$zodSchema,
+} from "./workflowmilestone.js";
+import { WSErrorCommon, WSErrorCommon$zodSchema } from "./wserrorcommon.js";
+
+export type GetAnnouncementArticlesRequest = {
+  acceptLanguage?: AcceptLanguage | undefined;
+  portalID: string;
+  dollarFilterTags?: string | undefined;
+  workflowMilestone?: WorkflowMilestone | undefined;
+  Dollar_lang?: LanguageQueryParameter | undefined;
+  Dollar_pagenum?: number | undefined;
+  Dollar_pagesize?: number | undefined;
+};
+
+export const GetAnnouncementArticlesRequest$zodSchema: z.ZodType<
+  GetAnnouncementArticlesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Dollar_lang: LanguageQueryParameter$zodSchema.default("en-US"),
+  Dollar_pagenum: z.number().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(
+    "Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.",
+  ),
+  acceptLanguage: AcceptLanguage$zodSchema.default("en-US"),
+  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(),
+  portalID: z.string().describe(
+    "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(),
+});
+
+export type GetAnnouncementArticlesResponse = {
+  ContentType: string;
+  StatusCode: number;
+  RawResponse: Response;
+  ArticleResults?: ArticleResults | undefined;
+  WSErrorCommon?: WSErrorCommon | undefined;
+};
+
+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(),
+});

package/src/models/getarticlebyidop.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { AcceptLanguage, AcceptLanguage$zodSchema } from "./acceptlanguage.js";
+import { Article, Article$zodSchema } from "./article.js";
+import {
+  ArticleAdditionalAttributes,
+  ArticleAdditionalAttributes$zodSchema,
+} from "./articleadditionalattributes.js";
+import {
+  LanguageQueryParameter,
+  LanguageQueryParameter$zodSchema,
+} from "./languagequeryparameter.js";
+import {
+  WorkflowMilestone,
+  WorkflowMilestone$zodSchema,
+} from "./workflowmilestone.js";
+import { WSErrorCommon, WSErrorCommon$zodSchema } from "./wserrorcommon.js";
+
+/**
+ * Provides information about the method in which the Article is accessed and is used for self-service analytics. Refer to the eGain User Guide regarding "Article View Contexts".
+ *
+ * @remarks
+ *
+ * | Name | Description
+ * | ---- | -----------
+ * | article_view | View an Article directly using its ID.
+ * | article_view_more_related_Article  | View related articles of an Article using its ID.
+ * | article_view_basic_search | View an Article via a basic search.
+ * | article_view_adv_search | View an Article via an advanced search.
+ * | article_view_guided_help | View an Article via a Guided Help solution.
+ * | article_view_browse_topic | View an Article via browsing a topic.
+ * | article_view_browse_tree | View an Article via browsing a topic tree.
+ * | article_view_popular_articles | View an Article using the Popular Items list in the Self-Service portal.
+ * | article_view_useful_items | View Article using the Useful Items list in the Self-Service portal.
+ * | article_view_widget | View an Article via a widget.
+ * | article_view_announcement | View an Article from the announcement section in the Self-Service portal.
+ * | article_view_bookmarked | View a bookmarked Article.
+ * | article_view_subscription_notification | View an Article from a subscription notification.
+ * | article_view_guided_help_additional_info | View an Article via additional information from a Guided Help search.
+ * | view_articles_pending_compliance | View an Article via Read & Sign in the Self-Service portal.
+ * | type_ahead_Suggestion | View an Article from a type-ahead Suggestion in the Self-Service portal.
+ * | semantic_Suggestion | View an Article from a semantic Suggestion in the Self-Service portal.
+ * | instant_answer | View an Article via an Instant Answers solution.
+ * | instant_answer_reference | View an Article that is used as a reference for an Instant Answers solution.
+ */
+export const AccessSource$zodSchema = z.enum([
+  "article_view",
+  "article_view_more_related_Article",
+  "article_view_basic_search",
+  "article_view_adv_search",
+  "article_view_guided_help",
+  "article_view_browse_topic",
+  "article_view_browse_tree",
+  "article_view_popular_articles",
+  "article_view_useful_items",
+  "article_view_widget",
+  "article_view_announcement",
+  "article_view_bookmarked",
+  "article_view_subscription_notification",
+  "article_view_guided_help_additional_info",
+  "view_articles_pending_compliance",
+  "type_ahead_Suggestion",
+  "semantic_Suggestion",
+  "instant_answer",
+  "instant_answer_reference",
+]).describe(
+  "Provides information about the method in which the Article is accessed and is used for self-service analytics. Refer to the eGain User Guide regarding \"Article View Contexts\".\n"
+    + "\n"
+    + "| Name | Description \n"
+    + "| ---- | -----------\n"
+    + "| article_view | View an Article directly using its ID.\n"
+    + "| article_view_more_related_Article  | View related articles of an Article using its ID.\n"
+    + "| article_view_basic_search | View an Article via a basic search.\n"
+    + "| article_view_adv_search | View an Article via an advanced search.\n"
+    + "| article_view_guided_help | View an Article via a Guided Help solution.\n"
+    + "| article_view_browse_topic | View an Article via browsing a topic.\n"
+    + "| article_view_browse_tree | View an Article via browsing a topic tree.\n"
+    + "| article_view_popular_articles | View an Article using the Popular Items list in the Self-Service portal.\n"
+    + "| article_view_useful_items | View Article using the Useful Items list in the Self-Service portal.\n"
+    + "| article_view_widget | View an Article via a widget.\n"
+    + "| article_view_announcement | View an Article from the announcement section in the Self-Service portal.\n"
+    + "| article_view_bookmarked | View a bookmarked Article.\n"
+    + "| article_view_subscription_notification | View an Article from a subscription notification.\n"
+    + "| article_view_guided_help_additional_info | View an Article via additional information from a Guided Help search.\n"
+    + "| view_articles_pending_compliance | View an Article via Read & Sign in the Self-Service portal.\n"
+    + "| type_ahead_Suggestion | View an Article from a type-ahead Suggestion in the Self-Service portal.\n"
+    + "| semantic_Suggestion | View an Article from a semantic Suggestion in the Self-Service portal.\n"
+    + "| instant_answer | View an Article via an Instant Answers solution.\n"
+    + "| instant_answer_reference | View an Article that is used as a reference for an Instant Answers solution.\n"
+    + "",
+);
+
+export type AccessSource = z.infer<typeof AccessSource$zodSchema>;
+
+export type GetArticleByIdRequest = {
+  acceptLanguage?: AcceptLanguage | undefined;
+  portalID: string;
+  articleID: string;
+  Dollar_lang?: LanguageQueryParameter | undefined;
+  articleAdditionalAttributes?: Array<ArticleAdditionalAttributes> | undefined;
+  Dollar_customAdditionalAttributes?: string | undefined;
+  accessSource?: AccessSource | undefined;
+  publishViewId?: string | undefined;
+  workflowMilestone?: WorkflowMilestone | undefined;
+};
+
+export const GetArticleByIdRequest$zodSchema: z.ZodType<
+  GetArticleByIdRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Dollar_customAdditionalAttributes: z.string().optional(),
+  Dollar_lang: LanguageQueryParameter$zodSchema.default("en-US"),
+  acceptLanguage: AcceptLanguage$zodSchema.default("en-US"),
+  accessSource: AccessSource$zodSchema.default("article_view"),
+  articleAdditionalAttributes: z.array(ArticleAdditionalAttributes$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\n"
+        + "These 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"
+        + "| additionalInfo | Additional information provided as Article metadata.\n"
+        + "| articleType | The Article type and its attributes.\n"
+        + "| articleKeywords | A comma-separated list of keywords associated with this Article.\n"
+        + "| articleState | The current state of the Article. States include A (Authoring), S (Staging), and P (Published).\n"
+        + "| articleSummary | A brief summary of the Article, provided as metadata.\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"
+        + "| departmentId | ID of the department for which this Article belongs to.\n"
+        + "| description | The Article's description.\n"
+        + "| expirationDate | The date that the Article is set to expire.\n"
+        + "| attachments | The Article's attachments\n"
+        + "| imageURL | The URL of the image that is present in the Article version. It is used as the thumbnail image for the Article.\n"
+        + "| includeInGenAI | Indicates whether this Article is used for eGain's generative AI features.\n"
+        + "| isSubscribed | Indicates whether the Article is subscribed for notifications. \n"
+        + "| languageCode | The language code of the Article language. \n"
+        + "| link | The link object, used to retrieve the details of the Article.\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"
+        + "| topicBreadcrumb | Contains a list of topics from the top-level topic to this Article. There may be multiple paths.\n"
+        + "| versionId | The ID of the Article version that is returned.\n"
+        + "",
+    ).optional(),
+  articleID: z.string().describe(
+    "The ID of the Article.<br><br>An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits.",
+  ),
+  portalID: z.string().describe(
+    "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.",
+  ),
+  publishViewId: z.string().describe(
+    "The ID of a publish view for an Article. A publish view is a set of tags used to generate multiple editions of the same Article for display on the self-service portal. Publish views are used in conjunction with single sourcing to tailor the content of an Article to a specific audience by granting access to an Article's version to users that possess the same tags.<br><br>A publish view ID is composed of a 4-letter prefix, followed by a dash and 4-15 digits.",
+  ).optional(),
+  workflowMilestone: WorkflowMilestone$zodSchema.optional(),
+});
+
+export type GetArticleByIdResponse = {
+  ContentType: string;
+  StatusCode: number;
+  RawResponse: Response;
+  Article?: Article | undefined;
+  WSErrorCommon?: WSErrorCommon | undefined;
+};
+
+export const GetArticleByIdResponse$zodSchema: z.ZodType<
+  GetArticleByIdResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Article: Article$zodSchema.optional(),
+  ContentType: z.string(),
+  RawResponse: z.instanceof(Response),
+  StatusCode: z.number().int(),
+  WSErrorCommon: WSErrorCommon$zodSchema.optional(),
+});