@egain/egain-mcp-server 1.0.20 → 1.0.22

package/esm/src/models/topicsummary.js

@@ -2,8 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 import * as z from "zod";
+import { Link$zodSchema } from "./link.js";
 export const TopicSummary$zodSchema = z.object({
     id: z.string().optional(),
+    link: Link$zodSchema.optional(),
     name: z.string().optional(),
 }).describe("This schema contains the topic ID and name of the topics. This is used by TopicBreadcrumb.");
 //# sourceMappingURL=topicsummary.js.map

package/esm/src/models/topicsummary.js.map

@@ -1 +1 @@
-{"version":3,"file":"topicsummary.js","sourceRoot":"","sources":["../../../src/models/topicsummary.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAUzB,MAAM,CAAC,MAAM,sBAAsB,GAI/B,CAAC,CAAC,MAAM,CAAC;IACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC,QAAQ,CACT,4FAA4F,CAC7F,CAAC"}
+{"version":3,"file":"topicsummary.js","sourceRoot":"","sources":["../../../src/models/topicsummary.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAQ,cAAc,EAAE,MAAM,WAAW,CAAC;AAWjD,MAAM,CAAC,MAAM,sBAAsB,GAI/B,CAAC,CAAC,MAAM,CAAC;IACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,cAAc,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC,QAAQ,CACT,4FAA4F,CAC7F,CAAC"}

package/esm/src/models/wserrorcommon.d.ts

@@ -5,7 +5,7 @@ export type Detail = {
 };
 export declare const Detail$zodSchema: z.ZodType<Detail, z.ZodTypeDef, unknown>;
 /**
- * Error Schema
+ * Bad Request
  */
 export type WSErrorCommon = {
     code: string;

package/esm/src/models/wserrorcommon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wserrorcommon.d.ts","sourceRoot":"","sources":["../../../src/models/wserrorcommon.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,MAAM,MAAM,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEjE,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAIlE,CAAC;AAEL;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACpC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CAMkB,CAAC"}
+{"version":3,"file":"wserrorcommon.d.ts","sourceRoot":"","sources":["../../../src/models/wserrorcommon.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,MAAM,MAAM,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEjE,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAIlE,CAAC;AAEL;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACpC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CAMiB,CAAC"}

package/esm/src/models/wserrorcommon.js

@@ -12,5 +12,5 @@ export const WSErrorCommon$zodSchema = z.object({
     details: z.array(z.lazy(() => Detail$zodSchema)).optional(),
     developerMessage: z.string(),
     userMessage: z.string().optional(),
-}).describe("Error Schema");
+}).describe("Bad Request");
 //# sourceMappingURL=wserrorcommon.js.map

package/esm/src/models/wserrorcommon.js.map

@@ -1 +1 @@
-{"version":3,"file":"wserrorcommon.js","sourceRoot":"","sources":["../../../src/models/wserrorcommon.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB,MAAM,CAAC,MAAM,gBAAgB,GAA6C,CAAC;KACxE,MAAM,CAAC;IACN,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC;AAYL,MAAM,CAAC,MAAM,uBAAuB,GAIhC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3D,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC"}
+{"version":3,"file":"wserrorcommon.js","sourceRoot":"","sources":["../../../src/models/wserrorcommon.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB,MAAM,CAAC,MAAM,gBAAgB,GAA6C,CAAC;KACxE,MAAM,CAAC;IACN,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC;AAYL,MAAM,CAAC,MAAM,uBAAuB,GAIhC,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3D,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC"}

package/manifest.json

@@ -1,7 +1,7 @@
 {
   "dxt_version": "0.1",
   "name": "@egain/egain-mcp-server",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "description": "",
   "long_description": "eGain Portal, Retrieve, Search, Answers APIs: Enterprise knowledge APIs for managing portals, searching content, retrieving AI-powered answers, and accessing content chunks for custom integrations.",
   "author": {
@@ -26,6 +26,14 @@
   },
   "display_name": "@egain/egain Mcp Server",
   "tools": [
+    {
+      "name": "query-retrieve",
+      "description": "Retrieve Chunks\n\nRetrieve Chunks\n\n## Prerequisites\n- **Requires a valid portal ID** (required parameter). If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines.\n\nIn addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility.\n\nBy leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.\n"
+    },
+    {
+      "name": "query-answers",
+      "description": "Generate an Answer\n\nGet Answers\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Answers API enables users to get the best answer for a user query. This API can return certified answers or generative answers along with search results, providing users with comprehensive responses to their questions.\n\nThe API leverages AI capabilities to provide intelligent answers based on the knowledge base content, making it easier for users to find the information they need quickly and accurately.\n\n## Request Body Notes\n- **channel field**: Optional. **Recommended to omit** unless specifically needed. The API works reliably without it. If you receive a 400 Bad Request error when including channel, retry the request without the channel field.\n- **Required fields**: eventId and sessionId are required in the request body.\n"
+    },
     {
       "name": "get-article",
       "description": "Get Article by ID\n\nGet Article by ID\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n- Requires a valid article ID. Article ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"PROD-2996\")\n\n## Overview\nThe Get Article by ID API allows a user to retrieve a specific article using its ID. Additional article attributes and contextual views can be specified in the query parameters.\n\nThis API returns structured authoring attributes of Issue, Environment, Cause and Confidence Level when the following conditions are met:\n- The \"Allow Structured Authoring\" setting is enabled at the partition/department level\n- The \"Use Structured Authoring\" flag is set on the article type\n"
@@ -42,21 +50,13 @@
       "name": "get-portals",
       "description": "Get All Portals Accessible To User\n\nGet All Portals Accessible to User\n\n## Overview\nThe Get All Portals Accessible to User API allows a user to fetch all portals accessible to the user across all departments.\n- If no access tags are specified for a portal, any user can access the portal.\n- If access tags are specified for a portal, users with a user profile that allows access can access the portal. For users with multiple user profiles, the user profile that allows access does not need to be the active user profile.\n- Global users (partition) cannot be assigned user profiles; their access is limited to portals without access restrictions.\n- The only articles returned are associated to an Article type when the parameter “Include in browse on portals” is set to \"Yes\".\n- When the \\`shortUrlTemplate\\` query parameter is provided, the API filters accessible portals according to the specified language and template name. A portal short URL specific to the \\`shortUrlTemplate\\` value is returned in the response when available. If there is no short URL for a language, the portal object returns an empty \\`shortURL\\` field.\n\n## Pagination behavior (CRITICAL for AI assistants)\n\n**IMPORTANT**: This endpoint is paginated. When searching for a portal by name or listing portals, you MUST automatically fetch ALL pages before concluding that a portal doesn't exist.\n\n### Automatic pagination is REQUIRED when:\n- User asks to find a portal by name (e.g., \"business portal\", \"Master portal\")\n- User requests to list or see all portals\n- You need to resolve a natural portal name to its ID\n\n### How to detect more pages exist:\nThe response includes \\`paginationInfo\\` with:\n- \\`count\\`: Total number of items across all pages\n- \\`pagenum\\`: Current page number\n- \\`pagesize\\`: Items per page (default: 25)\n\n**Check for more pages if ANY of these are true:**\n1. The number of portals returned equals \\`pagesize\\` (e.g., exactly 25 portals returned)\n2. \\`paginationInfo.count > (pagenum * pagesize)\\` - there are more items beyond this page\n3. The response includes a \\`link\\` array with a \\`next\\` relation\n\n### Required pagination workflow:\n1. Start with \\`$pagenum=1\\` and \\`$pagesize=25\\` (default)\n2. After receiving the response, check \\`paginationInfo\\`\n3. **If more pages exist** (using the checks above), automatically call this endpoint again with \\`$pagenum=2\\`, then \\`$pagenum=3\\`, etc.\n4. Continue incrementing \\`$pagenum\\` until:\n   - A page returns fewer portals than \\`pagesize\\` (indicating the last page)\n   - A page returns zero portals\n   - \\`pagenum * pagesize >= paginationInfo.count\\` (if count represents total items)\n5. Merge all portals from all pages by unique portal ID\n6. Only then search through the complete merged list or report results to the user\n\n### Example scenario:\nIf you search for \"business portal\" and the first page returns 25 portals but none match:\n- DO NOT immediately tell the user the portal doesn't exist\n- Check \\`paginationInfo.count\\` - if it's > 25, automatically fetch page 2\n- Continue fetching until all pages are retrieved\n- Search the complete merged list before concluding the portal doesn't exist\n\nThis ensures reliable portal name-to-ID resolution and prevents false \"not found\" errors.\n"
     },
-    {
-      "name": "make-suggestion",
-      "description": "Make a Suggestion\n\nMake a Suggestion\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Make a Suggestion API allows users to create an Article Suggestion from within a knowledge portal. This enables users to submit feedback, request new articles, or suggest improvements to existing content.\n\nUsers can submit suggestions with details about what they're looking for, which helps content creators understand user needs and improve the knowledge base.\n"
-    },
-    {
-      "name": "query-answers",
-      "description": "Get the best answer for a user query\n\nGet Answers\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Answers API enables users to get the best answer for a user query. This API can return certified answers or generative answers along with search results, providing users with comprehensive responses to their questions.\n\nThe API leverages AI capabilities to provide intelligent answers based on the knowledge base content, making it easier for users to find the information they need quickly and accurately.\n"
-    },
     {
       "name": "query-search",
-      "description": "Get the best search results for a user query\n\nThe Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores. <br>**This endpoint is only available for Self Service environments.**\n"
+      "description": "Hybrid Search\n\nThe Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores. <br>**This endpoint is only available for Self Service environments.**\n"
     },
     {
-      "name": "query-retrieve",
-      "description": "Retrieve Chunks\n\nRetrieve Chunks\n\n## Prerequisites\n- **Requires a valid portal ID** (required parameter). If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines.\n\nIn addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility.\n\nBy leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.\n"
+      "name": "make-suggestion",
+      "description": "Make a Suggestion\n\nMake a Suggestion\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Make a Suggestion API allows users to create an Article Suggestion from within a knowledge portal. This enables users to submit feedback, request new articles, or suggest improvements to existing content.\n\nUsers can submit suggestions with details about what they're looking for, which helps content creators understand user needs and improve the knowledge base.\n"
     }
   ],
   "prompts": [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@egain/egain-mcp-server",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "author": "Emily Loh - eGain Corporation",
   "type": "module",
   "sideEffects": false,

package/src/funcs/queryAnswers.ts

@@ -20,16 +20,16 @@ import {
 } from "../models/errors/httpclienterrors.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import {
-  PostPortalIDAnswersRequest,
-  PostPortalIDAnswersRequest$zodSchema,
-  PostPortalIDAnswersResponse,
-  PostPortalIDAnswersResponse$zodSchema,
-} from "../models/postportalidanswersop.js";
+  GetBestAnswerRequest,
+  GetBestAnswerRequest$zodSchema,
+  GetBestAnswerResponse,
+  GetBestAnswerResponse$zodSchema,
+} from "../models/getbestanswerop.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get the best answer for a user query
+ * Generate an Answer
  *
  * @remarks
  * Get Answers
@@ -42,14 +42,18 @@ import { Result } from "../types/fp.js";
  * The Answers API enables users to get the best answer for a user query. This API can return certified answers or generative answers along with search results, providing users with comprehensive responses to their questions.
  *
  * The API leverages AI capabilities to provide intelligent answers based on the knowledge base content, making it easier for users to find the information they need quickly and accurately.
+ *
+ * ## Request Body Notes
+ * - **channel field**: Optional. **Recommended to omit** unless specifically needed. The API works reliably without it. If you receive a 400 Bad Request error when including channel, retry the request without the channel field.
+ * - **Required fields**: eventId and sessionId are required in the request body.
  */
 export function queryAnswers(
   client$: EgainMcpCore,
-  request: PostPortalIDAnswersRequest,
+  request: GetBestAnswerRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    PostPortalIDAnswersResponse,
+    GetBestAnswerResponse,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -68,12 +72,12 @@ export function queryAnswers(
 
 async function $do(
   client$: EgainMcpCore,
-  request: PostPortalIDAnswersRequest,
+  request: GetBestAnswerRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      PostPortalIDAnswersResponse,
+      GetBestAnswerResponse,
       | APIError
       | SDKValidationError
       | UnexpectedClientError
@@ -87,7 +91,7 @@ async function $do(
 > {
   const parsed$ = safeParse(
     request,
-    (value$) => PostPortalIDAnswersRequest$zodSchema.parse(value$),
+    (value$) => GetBestAnswerRequest$zodSchema.parse(value$),
     "Input validation failed",
   );
   if (!parsed$.ok) {
@@ -123,7 +127,7 @@ async function $do(
   const context = {
     options: client$._options,
     baseURL: options?.serverURL ?? client$._baseURL ?? "",
-    operationID: "post_/{portalID}/answers",
+    operationID: "getBestAnswer",
     oAuth2Scopes: null,
     resolvedSecurity: requestSecurity,
     securitySource: client$._options.security,
@@ -171,7 +175,7 @@ async function $do(
   };
 
   const [result$] = await M.match<
-    PostPortalIDAnswersResponse,
+    GetBestAnswerResponse,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -180,11 +184,9 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, PostPortalIDAnswersResponse$zodSchema, {
-      key: "AnswersResponse",
-    }),
-    M.nil(400, PostPortalIDAnswersResponse$zodSchema),
-    M.nil(500, PostPortalIDAnswersResponse$zodSchema),
+    M.json(200, GetBestAnswerResponse$zodSchema, { key: "AnswersResponse" }),
+    M.nil(400, GetBestAnswerResponse$zodSchema),
+    M.nil(500, GetBestAnswerResponse$zodSchema),
   )(response, req$, { extraFields: responseFields$ });
 
   return [result$, { status: "complete", request: req$, response }];

package/src/funcs/queryRetrieve.ts

@@ -20,11 +20,11 @@ import {
 } from "../models/errors/httpclienterrors.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import {
-  PostPortalIDRetrieveRequest,
-  PostPortalIDRetrieveRequest$zodSchema,
-  PostPortalIDRetrieveResponse,
-  PostPortalIDRetrieveResponse$zodSchema,
-} from "../models/postportalidretrieveop.js";
+  RetrieveChunksRequest,
+  RetrieveChunksRequest$zodSchema,
+  RetrieveChunksResponse,
+  RetrieveChunksResponse$zodSchema,
+} from "../models/retrievechunksop.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
@@ -47,11 +47,11 @@ import { Result } from "../types/fp.js";
  */
 export function queryRetrieve(
   client$: EgainMcpCore,
-  request: PostPortalIDRetrieveRequest,
+  request: RetrieveChunksRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    PostPortalIDRetrieveResponse,
+    RetrieveChunksResponse,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -70,12 +70,12 @@ export function queryRetrieve(
 
 async function $do(
   client$: EgainMcpCore,
-  request: PostPortalIDRetrieveRequest,
+  request: RetrieveChunksRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      PostPortalIDRetrieveResponse,
+      RetrieveChunksResponse,
       | APIError
       | SDKValidationError
       | UnexpectedClientError
@@ -89,7 +89,7 @@ async function $do(
 > {
   const parsed$ = safeParse(
     request,
-    (value$) => PostPortalIDRetrieveRequest$zodSchema.parse(value$),
+    (value$) => RetrieveChunksRequest$zodSchema.parse(value$),
     "Input validation failed",
   );
   if (!parsed$.ok) {
@@ -125,7 +125,7 @@ async function $do(
   const context = {
     options: client$._options,
     baseURL: options?.serverURL ?? client$._baseURL ?? "",
-    operationID: "post_/{portalID}/retrieve",
+    operationID: "retrieveChunks",
     oAuth2Scopes: null,
     resolvedSecurity: requestSecurity,
     securitySource: client$._options.security,
@@ -173,7 +173,7 @@ async function $do(
   };
 
   const [result$] = await M.match<
-    PostPortalIDRetrieveResponse,
+    RetrieveChunksResponse,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -182,15 +182,9 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, PostPortalIDRetrieveResponse$zodSchema, {
-      key: "RetrieveResponse",
-    }),
-    M.json(400, PostPortalIDRetrieveResponse$zodSchema, {
-      key: "WSErrorCommon",
-    }),
-    M.json(500, PostPortalIDRetrieveResponse$zodSchema, {
-      key: "WSErrorCommon",
-    }),
+    M.json(200, RetrieveChunksResponse$zodSchema, { key: "RetrieveResponse" }),
+    M.nil(400, RetrieveChunksResponse$zodSchema),
+    M.nil(500, RetrieveChunksResponse$zodSchema),
   )(response, req$, { extraFields: responseFields$ });
 
   return [result$, { status: "complete", request: req$, response }];

package/src/funcs/querySearch.ts

@@ -13,8 +13,8 @@ import { pathToFunc } from "../lib/url.js";
 import {
   AiSearchRequest,
   AiSearchRequest$zodSchema,
-  AiSearchResponse,
-  AiSearchResponse$zodSchema,
+  AiSearchResponseResponse,
+  AiSearchResponseResponse$zodSchema,
 } from "../models/aisearchop.js";
 import { APIError } from "../models/errors/apierror.js";
 import {
@@ -29,7 +29,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get the best search results for a user query
+ * Hybrid Search
  *
  * @remarks
  * The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores. <br>**This endpoint is only available for Self Service environments.**
@@ -40,7 +40,7 @@ export function querySearch(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    AiSearchResponse,
+    AiSearchResponseResponse,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -64,7 +64,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      AiSearchResponse,
+      AiSearchResponseResponse,
       | APIError
       | SDKValidationError
       | UnexpectedClientError
@@ -101,6 +101,8 @@ async function $do(
     "$filter[topicIds]": payload$.dollarFilterTopicIds,
     "$filter[userProfileID]": payload$.dollarFilterUserProfileID,
     "$lang": payload$.Dollar_lang,
+    "$pagenum": payload$.Dollar_pagenum,
+    "$pagesize": payload$.Dollar_pagesize,
     "articleCustomAdditionalAttributes":
       payload$.articleCustomAdditionalAttributes,
     "q": payload$.q,
@@ -163,7 +165,7 @@ async function $do(
   };
 
   const [result$] = await M.match<
-    AiSearchResponse,
+    AiSearchResponseResponse,
     | APIError
     | SDKValidationError
     | UnexpectedClientError
@@ -172,9 +174,14 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, AiSearchResponse$zodSchema, { key: "SearchResponse" }),
-    M.nil(400, AiSearchResponse$zodSchema),
-    M.nil(500, AiSearchResponse$zodSchema),
+    M.json(200, AiSearchResponseResponse$zodSchema, {
+      key: "AISearchResponse",
+    }),
+    M.nil(204, AiSearchResponseResponse$zodSchema),
+    M.json([400, 401, 403, 404, 406], AiSearchResponseResponse$zodSchema, {
+      key: "WSErrorCommon",
+    }),
+    M.json(500, AiSearchResponseResponse$zodSchema, { key: "WSErrorCommon" }),
   )(response, req$, { extraFields: responseFields$ });
 
   return [result$, { status: "complete", request: req$, response }];