@egain/egain-mcp-server 1.0.26 → 1.1.0

package/src/models/getarticlebyidop.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
 import { AcceptLanguage, AcceptLanguage$zodSchema } from "./acceptlanguage.js";
 import { Article, Article$zodSchema } from "./article.js";
 import {
@@ -46,6 +47,57 @@ import { WSErrorCommon, WSErrorCommon$zodSchema } from "./wserrorcommon.js";
  * | 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 = {
+  ArticleView: "article_view",
+  ArticleViewMoreRelatedArticle: "article_view_more_related_Article",
+  ArticleViewBasicSearch: "article_view_basic_search",
+  ArticleViewAdvSearch: "article_view_adv_search",
+  ArticleViewGuidedHelp: "article_view_guided_help",
+  ArticleViewBrowseTopic: "article_view_browse_topic",
+  ArticleViewBrowseTree: "article_view_browse_tree",
+  ArticleViewPopularArticles: "article_view_popular_articles",
+  ArticleViewUsefulItems: "article_view_useful_items",
+  ArticleViewWidget: "article_view_widget",
+  ArticleViewAnnouncement: "article_view_announcement",
+  ArticleViewBookmarked: "article_view_bookmarked",
+  ArticleViewSubscriptionNotification: "article_view_subscription_notification",
+  ArticleViewGuidedHelpAdditionalInfo:
+    "article_view_guided_help_additional_info",
+  ViewArticlesPendingCompliance: "view_articles_pending_compliance",
+  TypeAheadSuggestion: "type_ahead_Suggestion",
+  SemanticSuggestion: "semantic_Suggestion",
+  InstantAnswer: "instant_answer",
+  InstantAnswerReference: "instant_answer_reference",
+} as const;
+/**
+ * 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 type AccessSource = ClosedEnum<typeof AccessSource>;
+
 export const AccessSource$zodSchema = z.enum([
   "article_view",
   "article_view_more_related_Article",
@@ -67,35 +119,13 @@ export const AccessSource$zodSchema = z.enum([
   "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"
-    + "",
+  "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 = {
+  xEgainActivityId?: string | undefined;
+  xExtIntegrationId?: string | undefined;
+  xExtInteractionId?: string | undefined;
   acceptLanguage?: AcceptLanguage | undefined;
   portalID: string;
   articleID: string;
@@ -107,76 +137,42 @@ export type GetArticleByIdRequest = {
   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"
-        + "",
+export const GetArticleByIdRequest$zodSchema: z.ZodType<GetArticleByIdRequest> =
+  z.object({
+    Dollar_customAdditionalAttributes: z.string().optional(),
+    Dollar_lang: LanguageQueryParameter$zodSchema.optional(),
+    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\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| 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(),
-  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(),
-});
+    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 GetArticleByIdResponse = {
-  ContentType: string;
-  StatusCode: number;
-  RawResponse: Response;
-  Article?: Article | undefined;
-  WSErrorCommon?: WSErrorCommon | undefined;
-};
+export type GetArticleByIdResponse = Article | WSErrorCommon;
 
 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(),
-});
+  GetArticleByIdResponse
+> = z.union([
+  Article$zodSchema,
+  WSErrorCommon$zodSchema,
+]);

package/src/models/getbestanswerop.ts

@@ -4,10 +4,6 @@
 
 import * as z from "zod";
 import { AnswersRequest, AnswersRequest$zodSchema } from "./answersrequest.js";
-import {
-  AnswersResponse,
-  AnswersResponse$zodSchema,
-} from "./answersresponse.js";
 import {
   RequiredLanguageCode,
   RequiredLanguageCode$zodSchema,
@@ -23,47 +19,19 @@ export type GetBestAnswerRequest = {
   AnswersRequest?: AnswersRequest | undefined;
 };
 
-export const GetBestAnswerRequest$zodSchema: z.ZodType<
-  GetBestAnswerRequest,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  AnswersRequest: AnswersRequest$zodSchema.optional(),
-  Dollar_lang: RequiredLanguageCode$zodSchema,
-  dollarFilterTags: z.record(z.array(z.string())).describe(
-    "An object where each key is a **Category Tag ID** (numeric string),  \n"
-      + "and each value is an array of **Tag IDs** for that category.\n"
-      + " **Note**:\n"
-      + "  - The '$filter[tags]' query parameter JSON value should be url encoded.\n"
-      + "  - Some developer tools for invoking APIs may not url encode the '$filter[tags]' query parameter JSON value by default. Ensure that only url encoded values are used.\n"
-      + "  - Example of JSON value: {\"BASE-40845\":[\"BASE-40849\",\"BASE-40853\"]}\n"
-      + "  - Example of URL encoded value: %7B%22BASE-40845%22%3A%5B%22BASE-40849%22%2C%22BASE-40853%22%5D%7D\n"
-      + "",
-  ).optional(),
-  dollarFilterTopicIds: z.array(z.string()).describe(
-    "An array of topic IDs. It is used to restrict search results to specific topics.",
-  ).optional(),
-  dollarFilterUserProfileID: z.string().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.",
-  ),
-  q: z.string().describe("The search query string."),
-});
-
-export type GetBestAnswerResponse = {
-  ContentType: string;
-  StatusCode: number;
-  RawResponse: Response;
-  AnswersResponse?: AnswersResponse | undefined;
-};
-
-export const GetBestAnswerResponse$zodSchema: z.ZodType<
-  GetBestAnswerResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  AnswersResponse: AnswersResponse$zodSchema.optional(),
-  ContentType: z.string(),
-  RawResponse: z.instanceof(Response),
-  StatusCode: z.number().int(),
-});
+export const GetBestAnswerRequest$zodSchema: z.ZodType<GetBestAnswerRequest> = z
+  .object({
+    AnswersRequest: AnswersRequest$zodSchema.optional(),
+    Dollar_lang: RequiredLanguageCode$zodSchema,
+    dollarFilterTags: z.record(z.string(), z.array(z.string())).describe(
+      "An object where each key is a **Category Tag ID** (numeric string),  \nand each value is an array of **Tag IDs** for that category.\n **Note**:\n  - The '$filter[tags]' query parameter JSON value should be url encoded.\n  - Some developer tools for invoking APIs may not url encode the '$filter[tags]' query parameter JSON value by default. Ensure that only url encoded values are used.\n  - Example of JSON value: {\"BASE-40845\":[\"BASE-40849\",\"BASE-40853\"]}\n  - Example of URL encoded value: %7B%22BASE-40845%22%3A%5B%22BASE-40849%22%2C%22BASE-40853%22%5D%7D\n",
+    ).optional(),
+    dollarFilterTopicIds: z.array(z.string()).describe(
+      "An array of topic IDs. It is used to restrict search results to specific topics.",
+    ).optional(),
+    dollarFilterUserProfileID: z.string().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.",
+    ),
+    q: z.string().describe("The search query string."),
+  });

package/src/models/getmyportalsop.ts

@@ -27,52 +27,37 @@ export type GetMyPortalsRequest = {
   shortUrlTemplate?: string | undefined;
   Dollar_sort?: SortIdNameDepartment | undefined;
   Dollar_order?: Order | undefined;
-  Dollar_pagesize?: number | undefined;
   Dollar_pagenum?: number | undefined;
+  Dollar_pagesize?: number | undefined;
 };
 
-export const GetMyPortalsRequest$zodSchema: z.ZodType<
-  GetMyPortalsRequest,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  Dollar_lang: MandatoryLanguageQueryParameter$zodSchema,
-  Dollar_order: Order$zodSchema.optional(),
-  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(25).describe(
-    "Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.<br>Valid range of 5-75<br>_Default value_: 25",
-  ),
-  Dollar_sort: SortIdNameDepartment$zodSchema.optional(),
-  acceptLanguage: AcceptLanguage$zodSchema.default("en-US"),
-  department: z.string().describe(
-    "The Name of the department for which portals are to be fetched",
-  ).optional(),
-  filterText: z.string().describe(
-    "Portal name starting with a specific character are considered to filter the result.",
-  ).optional(),
-  shortUrlTemplate: z.string().describe(
-    "The Name of the template used while creating Short URL.",
-  ).optional(),
-});
+export const GetMyPortalsRequest$zodSchema: z.ZodType<GetMyPortalsRequest> = z
+  .object({
+    Dollar_lang: MandatoryLanguageQueryParameter$zodSchema,
+    Dollar_order: Order$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.int().default(25).describe(
+      "Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.<br>Valid range of 5-75<br>_Default value_: 25",
+    ),
+    Dollar_sort: SortIdNameDepartment$zodSchema.optional(),
+    acceptLanguage: AcceptLanguage$zodSchema.default("en-US"),
+    department: z.string().describe(
+      "The Name of the department for which portals are to be fetched",
+    ).optional(),
+    filterText: z.string().describe(
+      "Portal name starting with a specific character are considered to filter the result.",
+    ).optional(),
+    shortUrlTemplate: z.string().describe(
+      "The Name of the template used while creating Short URL.",
+    ).optional(),
+  });
 
-export type GetMyPortalsResponse = {
-  ContentType: string;
-  StatusCode: number;
-  RawResponse: Response;
-  AllAccessiblePortals?: AllAccessiblePortals | undefined;
-  WSErrorCommon?: WSErrorCommon | undefined;
-};
+export type GetMyPortalsResponse = WSErrorCommon | AllAccessiblePortals;
 
-export const GetMyPortalsResponse$zodSchema: z.ZodType<
-  GetMyPortalsResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  AllAccessiblePortals: AllAccessiblePortals$zodSchema.optional(),
-  ContentType: z.string(),
-  RawResponse: z.instanceof(Response),
-  StatusCode: z.number().int(),
-  WSErrorCommon: WSErrorCommon$zodSchema.optional(),
-});
+export const GetMyPortalsResponse$zodSchema: z.ZodType<GetMyPortalsResponse> = z
+  .union([
+    WSErrorCommon$zodSchema,
+    AllAccessiblePortals$zodSchema,
+  ]);

package/src/models/getpopulararticlesop.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,
@@ -13,27 +17,36 @@ import { WSErrorCommon, WSErrorCommon$zodSchema } from "./wserrorcommon.js";
 
 export type GetpopulararticlesRequest = {
   acceptLanguage?: AcceptLanguage | undefined;
+  xExtIntegrationId?: string | undefined;
+  xEgainActivityId?: string | undefined;
+  xExtInteractionId?: string | undefined;
   portalID: string;
   dollarFilterTopicId?: string | undefined;
   Dollar_lang?: LanguageQueryParameter | undefined;
   dollarFilterTags?: string | undefined;
   Dollar_pagenum?: number | undefined;
   Dollar_pagesize?: number | undefined;
+  articleResultAdditionalAttributes?:
+    | Array<ArticleResultAdditionalAttributes>
+    | undefined;
 };
 
 export const GetpopulararticlesRequest$zodSchema: z.ZodType<
-  GetpopulararticlesRequest,
-  z.ZodTypeDef,
-  unknown
+  GetpopulararticlesRequest
 > = 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(),
@@ -43,24 +56,22 @@ export const GetpopulararticlesRequest$zodSchema: z.ZodType<
   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.",
   ),
+  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 GetpopulararticlesResponse = {
-  ContentType: string;
-  StatusCode: number;
-  RawResponse: Response;
-  ArticleResults?: ArticleResults | undefined;
-  WSErrorCommon?: WSErrorCommon | undefined;
-};
+export type GetpopulararticlesResponse = WSErrorCommon | ArticleResults;
 
 export const GetpopulararticlesResponse$zodSchema: z.ZodType<
-  GetpopulararticlesResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  ArticleResults: ArticleResults$zodSchema.optional(),
-  ContentType: z.string(),
-  RawResponse: z.instanceof(Response),
-  StatusCode: z.number().int(),
-  WSErrorCommon: WSErrorCommon$zodSchema.optional(),
-});
+  GetpopulararticlesResponse
+> = z.union([
+  WSErrorCommon$zodSchema,
+  ArticleResults$zodSchema,
+]);

package/src/models/l10nstring.ts

@@ -9,11 +9,7 @@ export type L10NString = {
   displayValue?: string | undefined;
 };
 
-export const L10NString$zodSchema: z.ZodType<
-  L10NString,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const L10NString$zodSchema: z.ZodType<L10NString> = z.object({
   displayValue: z.string().optional(),
   value: z.string().optional(),
 });

package/src/models/languagecode.ts

@@ -3,10 +3,48 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
 
 /**
  * Language code of the resource's language.
  */
+export const LanguageCode = {
+  EnUS: "en-US",
+  FRFR: "fr-FR",
+  EnGB: "en-GB",
+  ESES: "es-ES",
+  ITIT: "it-IT",
+  NLNL: "nl-NL",
+  DADA: "da-DA",
+  SvSE: "sv-SE",
+  PTPT: "pt-PT",
+  FIFI: "fi-FI",
+  NoNB: "no-NB",
+  NoNN: "no-NN",
+  JAJA: "ja-JA",
+  DEDE: "de-DE",
+  PtBR: "pt-BR",
+  ZhCN: "zh-CN",
+  ZhTW: "zh-TW",
+  KOKO: "ko-KO",
+  RURU: "ru-RU",
+  ELEL: "el-EL",
+  TRTR: "tr-TR",
+  PLPL: "pl-PL",
+  CSCS: "cs-CS",
+  SKSK: "sk-SK",
+  HUHU: "hu-HU",
+  SRSR: "sr-SR",
+  ArSA: "ar-SA",
+  HRHR: "hr-HR",
+  RORO: "ro-RO",
+  THTH: "th-TH",
+} as const;
+/**
+ * Language code of the resource's language.
+ */
+export type LanguageCode = ClosedEnum<typeof LanguageCode>;
+
 export const LanguageCode$zodSchema = z.enum([
   "en-US",
   "fr-FR",
@@ -39,5 +77,3 @@ export const LanguageCode$zodSchema = z.enum([
   "ro-RO",
   "th-TH",
 ]).describe("Language code of the resource's language.");
-
-export type LanguageCode = z.infer<typeof LanguageCode$zodSchema>;

package/src/models/languagecodeparameter.ts

@@ -3,10 +3,54 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+
+export const LanguageCodeParameter = {
+  EnUS: "en-US",
+  FRFR: "fr-FR",
+  EnGB: "en-GB",
+  ESES: "es-ES",
+  ITIT: "it-IT",
+  NLNL: "nl-NL",
+  DADA: "da-DA",
+  SvSE: "sv-SE",
+  PTPT: "pt-PT",
+  FIFI: "fi-FI",
+  NoNB: "no-NB",
+  NoNN: "no-NN",
+  JAJA: "ja-JA",
+  DEDE: "de-DE",
+  PtBR: "pt-BR",
+  ZhCN: "zh-CN",
+  ZhTW: "zh-TW",
+  KOKO: "ko-KO",
+  RURU: "ru-RU",
+  ELEL: "el-EL",
+  TRTR: "tr-TR",
+  PLPL: "pl-PL",
+  CSCS: "cs-CS",
+  SKSK: "sk-SK",
+  HUHU: "hu-HU",
+  SRSR: "sr-SR",
+  ArSA: "ar-SA",
+  HRHR: "hr-HR",
+  RORO: "ro-RO",
+  THTH: "th-TH",
+  DeAT: "de-AT",
+  ViVN: "vi-VN",
+  IDID: "id-ID",
+  MsMY: "ms-MY",
+  FilPH: "fil-PH",
+  FrCA: "fr-CA",
+  HiIN: "hi-IN",
+  UkUA: "uk-UA",
+  BGBG: "bg-BG",
+  SlSI: "sl-SI",
+  SrRS: "sr-RS",
+  XXXX: "xx-XX",
+} as const;
+export type LanguageCodeParameter = ClosedEnum<typeof LanguageCodeParameter>;
 
-/**
- * The language that describes the details of a resource. Resources available in different languages may differ from each other.<li>If <code>$lang</code> is not passed, then the portal's default language is used.</li><br><br>**Important**: When using this API via SDK or MCP, use the parameter name `Dollar_lang`, not `$lang` or `lang`.
- */
 export const LanguageCodeParameter$zodSchema = z.enum([
   "en-US",
   "fr-FR",
@@ -50,10 +94,4 @@ export const LanguageCodeParameter$zodSchema = z.enum([
   "sl-SI",
   "sr-RS",
   "xx-XX",
-]).describe(
-  "The language that describes the details of a resource. Resources available in different languages may differ from each other.<li>If <code>$lang</code> is not passed, then the portal's default language is used.</li><br><br>**Important**: When using this API via SDK or MCP, use the parameter name `Dollar_lang`, not `$lang` or `lang`.",
-);
-
-export type LanguageCodeParameter = z.infer<
-  typeof LanguageCodeParameter$zodSchema
->;
+]);