@egain/egain-mcp-server 1.0.1

package/src/funcs/getArticle.ts

@@ -0,0 +1,208 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { EgainMcpCore } from "../core.js";
+import { encodeFormQuery, encodeSimple, queryJoin } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  GetArticleByIdRequest,
+  GetArticleByIdRequest$zodSchema,
+  GetArticleByIdResponse,
+  GetArticleByIdResponse$zodSchema,
+} from "../models/getarticlebyidop.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get Article by ID
+ *
+ * @remarks
+ * Get Article by ID
+ *
+ * ## Prerequisites
+ * - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
+ * - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
+ * - Requires a valid article ID. Article ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "PROD-2996")
+ *
+ * ## Overview
+ * The 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.
+ *
+ * This API returns structured authoring attributes of Issue, Environment, Cause and Confidence Level when the following conditions are met:
+ * - The "Allow Structured Authoring" setting is enabled at the partition/department level
+ * - The "Use Structured Authoring" flag is set on the article type
+ */
+export function getArticle(
+  client$: EgainMcpCore,
+  request: GetArticleByIdRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    GetArticleByIdResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client$,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client$: EgainMcpCore,
+  request: GetArticleByIdRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      GetArticleByIdResponse,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed$ = safeParse(
+    request,
+    (value$) => GetArticleByIdRequest$zodSchema.parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = null;
+
+  const pathParams$ = {
+    articleID: encodeSimple("articleID", payload$.articleID, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    portalID: encodeSimple("portalID", payload$.portalID, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path$ = pathToFunc("/portals/{portalID}/articles/{articleID}")(
+    pathParams$,
+  );
+  const query$ = queryJoin(
+    encodeFormQuery({
+      "articleAdditionalAttributes": payload$.articleAdditionalAttributes,
+    }, { explode: false }),
+    encodeFormQuery({
+      "$customAdditionalAttributes": payload$.Dollar_customAdditionalAttributes,
+      "$lang": payload$.Dollar_lang,
+      "accessSource": payload$.accessSource,
+      "publishViewId": payload$.publishViewId,
+      "workflowMilestone": payload$.workflowMilestone,
+    }),
+  );
+
+  const headers$ = new Headers(compactMap({
+    Accept: "application/json",
+    "Accept-Language": encodeSimple(
+      "Accept-Language",
+      payload$.acceptLanguage,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "getArticleById",
+    oAuth2Scopes: null,
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    query: query$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+      || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  const response = doResult.value;
+  const responseFields$ = {
+    HttpMeta: { Response: response, Request: req$ },
+  };
+
+  const [result$] = await M.match<
+    GetArticleByIdResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, GetArticleByIdResponse$zodSchema, { key: "Article" }),
+    M.nil(204, GetArticleByIdResponse$zodSchema),
+    M.json([400, 401, 403, 404, 406], GetArticleByIdResponse$zodSchema, {
+      key: "WSErrorCommon",
+    }),
+    M.json(500, GetArticleByIdResponse$zodSchema, { key: "WSErrorCommon" }),
+  )(response, req$, { extraFields: responseFields$ });
+
+  return [result$, { status: "complete", request: req$, response }];
+}

package/src/funcs/getPopularArticles.ts

@@ -0,0 +1,198 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { EgainMcpCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  GetpopulararticlesRequest,
+  GetpopulararticlesRequest$zodSchema,
+  GetpopulararticlesResponse,
+  GetpopulararticlesResponse$zodSchema,
+} from "../models/getpopulararticlesop.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get Popular Articles
+ *
+ * @remarks
+ * Get Popular Articles
+ *
+ * ## Prerequisites
+ * - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
+ * - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
+ *
+ * ## Overview
+ * The Popular Articles API allows a user to retrieve the most popular articles from a specific portal. Popular articles are typically determined by user engagement metrics such as views, ratings, or usage frequency.
+ *
+ * This API returns a list of popular articles with their metadata, allowing users to discover the most relevant and frequently accessed content within the portal.
+ */
+export function getPopularArticles(
+  client$: EgainMcpCore,
+  request: GetpopulararticlesRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    GetpopulararticlesResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client$,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client$: EgainMcpCore,
+  request: GetpopulararticlesRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      GetpopulararticlesResponse,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed$ = safeParse(
+    request,
+    (value$) => GetpopulararticlesRequest$zodSchema.parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = null;
+
+  const pathParams$ = {
+    portalID: encodeSimple("portalID", payload$.portalID, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path$ = pathToFunc("/portals/{portalID}/populararticles")(
+    pathParams$,
+  );
+  const query$ = encodeFormQuery({
+    "$filter[tags]": payload$.dollarFilterTags,
+    "$filter[topicId]": payload$.dollarFilterTopicId,
+    "$lang": payload$.Dollar_lang,
+    "$pagenum": payload$.Dollar_pagenum,
+    "$pagesize": payload$.Dollar_pagesize,
+  });
+
+  const headers$ = new Headers(compactMap({
+    Accept: "application/json",
+    "Accept-Language": encodeSimple(
+      "Accept-Language",
+      payload$.acceptLanguage,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "getpopulararticles",
+    oAuth2Scopes: null,
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    query: query$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+      || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  const response = doResult.value;
+  const responseFields$ = {
+    HttpMeta: { Response: response, Request: req$ },
+  };
+
+  const [result$] = await M.match<
+    GetpopulararticlesResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, GetpopulararticlesResponse$zodSchema, {
+      key: "ArticleResults",
+    }),
+    M.nil(204, GetpopulararticlesResponse$zodSchema),
+    M.json([400, 401, 403, 404, 406], GetpopulararticlesResponse$zodSchema, {
+      key: "WSErrorCommon",
+    }),
+    M.json(500, GetpopulararticlesResponse$zodSchema, { key: "WSErrorCommon" }),
+  )(response, req$, { extraFields: responseFields$ });
+
+  return [result$, { status: "complete", request: req$, response }];
+}

package/src/funcs/getPortals.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { EgainMcpCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  GetMyPortalsRequest,
+  GetMyPortalsRequest$zodSchema,
+  GetMyPortalsResponse,
+  GetMyPortalsResponse$zodSchema,
+} from "../models/getmyportalsop.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get All Portals Accessible To User
+ *
+ * @remarks
+ * ## Overview
+ *   The Get All Portals Accessible to User API allows a user to fetch all portals accessible to user across all department.
+ *   * If no access tags are specified for a portal, then any user can access the portal.
+ *   * If access tags are specified for a portal, users with a user profile that allows access have access to the portal. For users with multiple user profiles, the user profile that allows access does not need to be the active user profile.
+ *   * All the global users(partition) cannot be assigned user profiles; their access is limited to portals without access restrictions.
+ *   * The only articles returned are associated to an Article type when the parameter, “Include in browse on portals” is set to "Yes".
+ *   * When the "shortUrlTemplate" query parameter is provided, the API filters accessible portals according to the specified language and template name. Portal Short URL specific to to the "shortUrlTemplate" query parameter value is returned in the response.
+ *   * When there is no short URL available for a specific language, the API returns a portal object with an empty "shortURL" field.
+ */
+export function getPortals(
+  client$: EgainMcpCore,
+  request: GetMyPortalsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    GetMyPortalsResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client$,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client$: EgainMcpCore,
+  request: GetMyPortalsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      GetMyPortalsResponse,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed$ = safeParse(
+    request,
+    (value$) => GetMyPortalsRequest$zodSchema.parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = null;
+  const path$ = pathToFunc("/myportals")();
+  const query$ = encodeFormQuery({
+    "$lang": payload$.Dollar_lang,
+    "$order": payload$.Dollar_order,
+    "$pagenum": payload$.Dollar_pagenum,
+    "$pagesize": payload$.Dollar_pagesize,
+    "$sort": payload$.Dollar_sort,
+    "department": payload$.department,
+    "filterText": payload$.filterText,
+    "shortUrlTemplate": payload$.shortUrlTemplate,
+  });
+
+  const headers$ = new Headers(compactMap({
+    Accept: "application/json",
+    "Accept-Language": encodeSimple(
+      "Accept-Language",
+      payload$.acceptLanguage,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "getMyPortals",
+    oAuth2Scopes: null,
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    query: query$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+      || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  const response = doResult.value;
+  const responseFields$ = {
+    HttpMeta: { Response: response, Request: req$ },
+  };
+
+  const [result$] = await M.match<
+    GetMyPortalsResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, GetMyPortalsResponse$zodSchema, {
+      key: "AllAccessiblePortals",
+    }),
+    M.nil(204, GetMyPortalsResponse$zodSchema),
+    M.json([400, 401, 403, 404, 406], GetMyPortalsResponse$zodSchema, {
+      key: "WSErrorCommon",
+    }),
+    M.json(500, GetMyPortalsResponse$zodSchema, { key: "WSErrorCommon" }),
+  )(response, req$, { extraFields: responseFields$ });
+
+  return [result$, { status: "complete", request: req$, response }];
+}