@egain/egain-mcp-server 1.0.1

package/src/models/postportalidretrieveop.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  LanguageCodeParameter,
+  LanguageCodeParameter$zodSchema,
+} from "./languagecodeparameter.js";
+import {
+  RetrieveRequest,
+  RetrieveRequest$zodSchema,
+} from "./retrieverequest.js";
+import {
+  RetrieveResponse,
+  RetrieveResponse$zodSchema,
+} from "./retrieveresponse.js";
+import { WSErrorCommon, WSErrorCommon$zodSchema } from "./wserrorcommon.js";
+
+export type PostPortalIDRetrieveRequest = {
+  q: string;
+  portalID: string;
+  dollarFilterUserProfileID?: string | undefined;
+  Dollar_lang?: LanguageCodeParameter | undefined;
+  dollarFilterTags?: { [k: string]: Array<string> } | undefined;
+  dollarFilterTopicIds?: Array<string> | undefined;
+  RetrieveRequest?: RetrieveRequest | undefined;
+};
+
+export const PostPortalIDRetrieveRequest$zodSchema: z.ZodType<
+  PostPortalIDRetrieveRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Dollar_lang: LanguageCodeParameter$zodSchema.default("en-US"),
+  RetrieveRequest: RetrieveRequest$zodSchema.optional(),
+  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"
+      + "",
+  ).optional(),
+  dollarFilterTopicIds: z.array(z.string()).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 PostPortalIDRetrieveResponse = {
+  ContentType: string;
+  StatusCode: number;
+  RawResponse: Response;
+  RetrieveResponse?: RetrieveResponse | undefined;
+  WSErrorCommon?: WSErrorCommon | undefined;
+};
+
+export const PostPortalIDRetrieveResponse$zodSchema: z.ZodType<
+  PostPortalIDRetrieveResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ContentType: z.string(),
+  RawResponse: z.instanceof(Response),
+  RetrieveResponse: RetrieveResponse$zodSchema.optional(),
+  StatusCode: z.number().int(),
+  WSErrorCommon: WSErrorCommon$zodSchema.optional(),
+});

package/src/models/publishview.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { TagCategory, TagCategory$zodSchema } from "./tagcategory.js";
+
+export type PublishViewTagCategory = {
+  tagCategory?: Array<TagCategory> | undefined;
+};
+
+export const PublishViewTagCategory$zodSchema: z.ZodType<
+  PublishViewTagCategory,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tagCategory: z.array(TagCategory$zodSchema).optional(),
+});
+
+export type PublishView = {
+  name?: string | undefined;
+  id?: string | undefined;
+  tagCategories?: Array<PublishViewTagCategory> | undefined;
+};
+
+export const PublishView$zodSchema: z.ZodType<
+  PublishView,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  name: z.string().optional(),
+  tagCategories: z.array(z.lazy(() => PublishViewTagCategory$zodSchema))
+    .optional(),
+});

package/src/models/referenceresponse.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  TopicBreadcrumb,
+  TopicBreadcrumb$zodSchema,
+} from "./topicbreadcrumb.js";
+
+/**
+ * Format of the source document (HTML, DOCX, PPTX, or PDF).
+ */
+export const ReferenceResponseDocType$zodSchema = z.enum([
+  "HTML",
+  "DOCX",
+  "PDF",
+  "PPTX",
+]).describe("Format of the source document (HTML, DOCX, PPTX, or PDF).");
+
+export type ReferenceResponseDocType = z.infer<
+  typeof ReferenceResponseDocType$zodSchema
+>;
+
+/**
+ * Source Type
+ */
+export const ReferenceResponseSource$zodSchema = z.enum([
+  "eGain Article",
+  "eGain Attachment",
+]).describe("Source Type");
+
+export type ReferenceResponseSource = z.infer<
+  typeof ReferenceResponseSource$zodSchema
+>;
+
+/**
+ * One document used in generated response
+ */
+export type ReferenceResponse = {
+  id: string;
+  name: string;
+  docName?: string | undefined;
+  docType: ReferenceResponseDocType;
+  source: ReferenceResponseSource;
+  topicBreadcrumb?: Array<TopicBreadcrumb> | undefined;
+};
+
+export const ReferenceResponse$zodSchema: z.ZodType<
+  ReferenceResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  docName: z.string().optional(),
+  docType: ReferenceResponseDocType$zodSchema,
+  id: z.string(),
+  name: z.string(),
+  source: ReferenceResponseSource$zodSchema,
+  topicBreadcrumb: z.array(TopicBreadcrumb$zodSchema).optional(),
+}).describe("One document used in generated response");

package/src/models/retrieverequest.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+/**
+ * The channel where the query originated, e.g., directly from the portal or via a custom integration.
+ */
+export const RetrieveRequestType$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 RetrieveRequestType = z.infer<typeof RetrieveRequestType$zodSchema>;
+
+export type RetrieveRequestChannel = {
+  type?: RetrieveRequestType | undefined;
+  name?: string | undefined;
+};
+
+export const RetrieveRequestChannel$zodSchema: z.ZodType<
+  RetrieveRequestChannel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  type: RetrieveRequestType$zodSchema.default("custom"),
+});
+
+export type RetrieveRequest = {
+  channel?: RetrieveRequestChannel | undefined;
+  eventId?: string | undefined;
+  sessionId?: string | undefined;
+};
+
+export const RetrieveRequest$zodSchema: z.ZodType<
+  RetrieveRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  channel: z.lazy(() => RetrieveRequestChannel$zodSchema).optional(),
+  eventId: z.string().optional(),
+  sessionId: z.string().optional(),
+});

package/src/models/retrieveresponse.ts

@@ -0,0 +1,92 @@
+/*
+ * 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";
+
+/**
+ * Specifies that the answer produced was a certified answer.
+ */
+export const RetrieveResponseAnswerType$zodSchema = z.enum([
+  "certified",
+]).describe("Specifies that the answer produced was a certified answer.");
+
+export type RetrieveResponseAnswerType = z.infer<
+  typeof RetrieveResponseAnswerType$zodSchema
+>;
+
+/**
+ * If a certified answer is given. The answer object will be present. <br><br> This will be shown only if certified answers are configured and the certified answer meets the configured threshold.
+ */
+export type RetrieveResponseAnswer = {
+  answerValue: string;
+  references: Array<ReferenceResponse>;
+  answerType: RetrieveResponseAnswerType;
+  relevanceScore: number;
+};
+
+export const RetrieveResponseAnswer$zodSchema: z.ZodType<
+  RetrieveResponseAnswer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  answerType: RetrieveResponseAnswerType$zodSchema,
+  answerValue: z.string(),
+  references: z.array(ReferenceResponse$zodSchema),
+  relevanceScore: z.number(),
+}).describe(
+  "If a certified answer is given. The answer object will be present. <br><br> This will be shown only if certified answers are configured and the certified answer meets the configured threshold.",
+);
+
+/**
+ * The channel where the query originated, e.g., directly from the portal or via a custom integration.
+ */
+export const RetrieveResponseType$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 RetrieveResponseType = z.infer<
+  typeof RetrieveResponseType$zodSchema
+>;
+
+export type RetrieveResponseChannel = {
+  type: RetrieveResponseType;
+  name?: string | undefined;
+};
+
+export const RetrieveResponseChannel$zodSchema: z.ZodType<
+  RetrieveResponseChannel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  type: RetrieveResponseType$zodSchema,
+});
+
+export type RetrieveResponse = {
+  answer?: RetrieveResponseAnswer | undefined;
+  searchResults: Array<SearchResult>;
+  channel?: RetrieveResponseChannel | undefined;
+  eventId?: string | undefined;
+  sessionId: string;
+};
+
+export const RetrieveResponse$zodSchema: z.ZodType<
+  RetrieveResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  answer: z.lazy(() => RetrieveResponseAnswer$zodSchema).optional(),
+  channel: z.lazy(() => RetrieveResponseChannel$zodSchema).optional(),
+  eventId: z.string().optional(),
+  searchResults: z.array(SearchResult$zodSchema),
+  sessionId: z.string(),
+});

package/src/models/schemaslink.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type SchemasLink = {
+  rel?: string | undefined;
+  href?: string | undefined;
+  _default?: boolean | undefined;
+};
+
+export const SchemasLink$zodSchema: z.ZodType<
+  SchemasLink,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _default: z.boolean().optional(),
+  href: z.string().optional(),
+  rel: z.string().optional(),
+});

package/src/models/searchresponse.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  ArticleSearchResult,
+  ArticleSearchResult$zodSchema,
+} from "./articlesearchresult.js";
+
+/**
+ * Top search results with relevance scores
+ */
+export type SearchResults = {
+  article?: Array<ArticleSearchResult> | undefined;
+};
+
+export const SearchResults$zodSchema: z.ZodType<
+  SearchResults,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  article: z.array(ArticleSearchResult$zodSchema).optional(),
+}).describe("Top search results with relevance scores");
+
+export type SearchResponse = { searchResults: SearchResults };
+
+export const SearchResponse$zodSchema: z.ZodType<
+  SearchResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  searchResults: z.lazy(() => SearchResults$zodSchema),
+});

package/src/models/searchresult.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  TopicBreadcrumb,
+  TopicBreadcrumb$zodSchema,
+} from "./topicbreadcrumb.js";
+
+/**
+ * Format of the source document (HTML, DOCX, PPTX, or PDF).
+ */
+export const SearchResultDocType$zodSchema = z.enum([
+  "HTML",
+  "DOCX",
+  "PDF",
+  "PPTX",
+]).describe("Format of the source document (HTML, DOCX, PPTX, or PDF).");
+
+export type SearchResultDocType = z.infer<typeof SearchResultDocType$zodSchema>;
+
+/**
+ * The repository or system where the content originated (e.g., eGain, SharePoint).
+ */
+export const SearchResultSource$zodSchema = z.enum([
+  "eGain Article",
+  "eGain Attachment",
+]).describe(
+  "The repository or system where the content originated (e.g., eGain, SharePoint).",
+);
+
+export type SearchResultSource = z.infer<typeof SearchResultSource$zodSchema>;
+
+/**
+ * Represents a single document or snippet returned by search, along with its metadata and relevance score.
+ */
+export type SearchResult = {
+  id: string;
+  name: string;
+  docName?: string | undefined;
+  docType: SearchResultDocType;
+  source: SearchResultSource;
+  snippet: string;
+  relevanceScore: number;
+  topicBreadcrumb?: Array<TopicBreadcrumb> | undefined;
+};
+
+export const SearchResult$zodSchema: z.ZodType<
+  SearchResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  docName: z.string().optional(),
+  docType: SearchResultDocType$zodSchema,
+  id: z.string(),
+  name: z.string(),
+  relevanceScore: z.number(),
+  snippet: z.string(),
+  source: SearchResultSource$zodSchema,
+  topicBreadcrumb: z.array(TopicBreadcrumb$zodSchema).optional(),
+}).describe(
+  "Represents a single document or snippet returned by search, along with its metadata and relevance score.",
+);

package/src/models/security.ts

@@ -0,0 +1,14 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type Security = { accessToken: string };
+
+export const Security$zodSchema: z.ZodType<Security, z.ZodTypeDef, unknown> = z
+  .object({
+    accessToken: z.string().describe(
+      "JWT Bearer Token authentication for API access",
+    ),
+  });

package/src/models/shorturl.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type ShortURL = {
+  id?: string | undefined;
+  templateName?: string | undefined;
+  shortURLName?: string | undefined;
+  isDefault?: boolean | undefined;
+};
+
+export const ShortURL$zodSchema: z.ZodType<ShortURL, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string().optional(),
+    isDefault: z.boolean().optional(),
+    shortURLName: z.string().optional(),
+    templateName: z.string().optional(),
+  });

package/src/models/sortidnamedepartment.ts

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export const SortIdNameDepartment$zodSchema = z.enum([
+  "id",
+  "name",
+  "departmentName",
+]);
+
+export type SortIdNameDepartment = z.infer<
+  typeof SortIdNameDepartment$zodSchema
+>;

package/src/models/stage.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { Milestone, Milestone$zodSchema } from "./milestone.js";
+
+/**
+ * A stage in the Article's workflow.
+ */
+export type Stage = {
+  name?: string | undefined;
+  milestone?: Milestone | undefined;
+};
+
+export const Stage$zodSchema: z.ZodType<Stage, z.ZodTypeDef, unknown> = z
+  .object({
+    milestone: Milestone$zodSchema.optional(),
+    name: z.string().optional(),
+  }).describe("A stage in the Article's workflow.");

package/src/models/structuredauthoringfields.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { L10NString, L10NString$zodSchema } from "./l10nstring.js";
+
+export type StructuredAuthoringFields = {
+  confidenceLevel?: L10NString | undefined;
+  issue?: string | undefined;
+  environment?: string | undefined;
+  cause?: string | undefined;
+};
+
+export const StructuredAuthoringFields$zodSchema: z.ZodType<
+  StructuredAuthoringFields,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  cause: z.string().optional(),
+  confidenceLevel: L10NString$zodSchema.optional(),
+  environment: z.string().optional(),
+  issue: z.string().optional(),
+});

package/src/models/tagcategory.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { TagGroups, TagGroups$zodSchema } from "./taggroups.js";
+import { Tags, Tags$zodSchema } from "./tags.js";
+
+/**
+ * A tag category is a grouping of tags and tag groups.
+ */
+export type TagCategory = {
+  name?: string | undefined;
+  id?: string | undefined;
+  tags?: Tags | undefined;
+  tagGroups?: TagGroups | undefined;
+};
+
+export const TagCategory$zodSchema: z.ZodType<
+  TagCategory,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  name: z.string().optional(),
+  tagGroups: TagGroups$zodSchema.optional(),
+  tags: Tags$zodSchema.optional(),
+}).describe("A tag category is a grouping of tags and tag groups.");

package/src/models/taggroup.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type TagGroup = { name?: string | undefined; id?: string | undefined };
+
+export const TagGroup$zodSchema: z.ZodType<TagGroup, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string().optional(),
+    name: z.string().optional(),
+  });

package/src/models/taggroups.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { TagGroup, TagGroup$zodSchema } from "./taggroup.js";
+
+export type TagGroups = { tagGroup?: Array<TagGroup> | undefined };
+
+export const TagGroups$zodSchema: z.ZodType<TagGroups, z.ZodTypeDef, unknown> =
+  z.object({
+    tagGroup: z.array(TagGroup$zodSchema).optional(),
+  });

package/src/models/tags.ts

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type Tags = {
+  id?: string | undefined;
+  tags?: Array<string> | undefined;
+};
+
+export const Tags$zodSchema: z.ZodType<Tags, z.ZodTypeDef, unknown> = z.object({
+  id: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+});

package/src/models/topicbreadcrumb.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { TopicSummary, TopicSummary$zodSchema } from "./topicsummary.js";
+
+/**
+ * This schema contains one or more TopicSummary instances.
+ */
+export type TopicBreadcrumb = {
+  topicSummary?: Array<TopicSummary> | undefined;
+};
+
+export const TopicBreadcrumb$zodSchema: z.ZodType<
+  TopicBreadcrumb,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  topicSummary: z.array(TopicSummary$zodSchema).optional(),
+}).describe("This schema contains one or more TopicSummary instances.");

package/src/models/topicsummary.ts

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

package/src/models/workflow.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { Stage, Stage$zodSchema } from "./stage.js";
+
+/**
+ * The Article's workflow.
+ */
+export type Workflow = { stages?: Array<Stage> | undefined };
+
+export const Workflow$zodSchema: z.ZodType<Workflow, z.ZodTypeDef, unknown> = z
+  .object({
+    stages: z.array(Stage$zodSchema).optional(),
+  }).describe("The Article's workflow.");

package/src/models/workflowmilestone.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export const WorkflowMilestone$zodSchema = z.enum([
+  "authoring",
+  "staging",
+  "publish",
+]);
+
+export type WorkflowMilestone = z.infer<typeof WorkflowMilestone$zodSchema>;