@egain/egain-mcp-server 1.0.26 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -43
- package/bin/mcp-server.js +39534 -29516
- package/bin/mcp-server.js.map +298 -185
- package/esm/src/cloudflare-worker/cloudflare-worker.d.ts.map +1 -1
- package/esm/src/cloudflare-worker/cloudflare-worker.js +20 -9
- package/esm/src/cloudflare-worker/cloudflare-worker.js.map +1 -1
- package/esm/src/funcs/aiSearch.d.ts +63 -0
- package/esm/src/funcs/aiSearch.d.ts.map +1 -0
- package/esm/src/funcs/aiSearch.js +151 -0
- package/esm/src/funcs/aiSearch.js.map +1 -0
- package/esm/src/funcs/getAnnouncementArticles.d.ts +61 -0
- package/esm/src/funcs/getAnnouncementArticles.d.ts.map +1 -0
- package/esm/src/funcs/getAnnouncementArticles.js +152 -0
- package/esm/src/funcs/getAnnouncementArticles.js.map +1 -0
- package/esm/src/funcs/getAnnouncements.d.ts +39 -1
- package/esm/src/funcs/getAnnouncements.d.ts.map +1 -1
- package/esm/src/funcs/getAnnouncements.js +39 -1
- package/esm/src/funcs/getAnnouncements.js.map +1 -1
- package/esm/src/funcs/getArticle.d.ts +42 -0
- package/esm/src/funcs/getArticle.d.ts.map +1 -1
- package/esm/src/funcs/getArticle.js +42 -0
- package/esm/src/funcs/getArticle.js.map +1 -1
- package/esm/src/funcs/getArticleById.d.ts +70 -0
- package/esm/src/funcs/getArticleById.d.ts.map +1 -0
- package/esm/src/funcs/getArticleById.js +163 -0
- package/esm/src/funcs/getArticleById.js.map +1 -0
- package/esm/src/funcs/getBestAnswer.d.ts +66 -0
- package/esm/src/funcs/getBestAnswer.d.ts.map +1 -0
- package/esm/src/funcs/getBestAnswer.js +148 -0
- package/esm/src/funcs/getBestAnswer.js.map +1 -0
- package/esm/src/funcs/getMyPortals.d.ts +97 -0
- package/esm/src/funcs/getMyPortals.d.ts.map +1 -0
- package/esm/src/funcs/getMyPortals.js +180 -0
- package/esm/src/funcs/getMyPortals.js.map +1 -0
- package/esm/src/funcs/getPopularArticles.d.ts +39 -0
- package/esm/src/funcs/getPopularArticles.d.ts.map +1 -1
- package/esm/src/funcs/getPopularArticles.js +47 -3
- package/esm/src/funcs/getPopularArticles.js.map +1 -1
- package/esm/src/funcs/getPortals.d.ts +26 -1
- package/esm/src/funcs/getPortals.d.ts.map +1 -1
- package/esm/src/funcs/getPortals.js +35 -10
- package/esm/src/funcs/getPortals.js.map +1 -1
- package/esm/src/funcs/makeSuggestion.d.ts +46 -2
- package/esm/src/funcs/makeSuggestion.d.ts.map +1 -1
- package/esm/src/funcs/makeSuggestion.js +51 -3
- package/esm/src/funcs/makeSuggestion.js.map +1 -1
- package/esm/src/funcs/queryAnswers.d.ts +41 -5
- package/esm/src/funcs/queryAnswers.d.ts.map +1 -1
- package/esm/src/funcs/queryAnswers.js +41 -5
- package/esm/src/funcs/queryAnswers.js.map +1 -1
- package/esm/src/funcs/queryRetrieve.d.ts +41 -1
- package/esm/src/funcs/queryRetrieve.d.ts.map +1 -1
- package/esm/src/funcs/queryRetrieve.js +41 -1
- package/esm/src/funcs/queryRetrieve.js.map +1 -1
- package/esm/src/funcs/querySearch.d.ts +48 -1
- package/esm/src/funcs/querySearch.d.ts.map +1 -1
- package/esm/src/funcs/querySearch.js +48 -1
- package/esm/src/funcs/querySearch.js.map +1 -1
- package/esm/src/funcs/retrieveChunks.d.ts +41 -7
- package/esm/src/funcs/retrieveChunks.d.ts.map +1 -1
- package/esm/src/funcs/retrieveChunks.js +45 -19
- package/esm/src/funcs/retrieveChunks.js.map +1 -1
- package/esm/src/hooks/auth-hook.d.ts +1 -2
- package/esm/src/hooks/auth-hook.d.ts.map +1 -1
- package/esm/src/hooks/auth-hook.js +1 -65
- package/esm/src/hooks/auth-hook.js.map +1 -1
- package/esm/src/hooks/registration.d.ts.map +1 -1
- package/esm/src/hooks/registration.js +2 -16
- package/esm/src/hooks/registration.js.map +1 -1
- package/esm/src/landing-page.d.ts +5 -0
- package/esm/src/landing-page.d.ts.map +1 -0
- package/esm/src/landing-page.js +1070 -0
- package/esm/src/landing-page.js.map +1 -0
- package/esm/src/lib/base64.d.ts +2 -2
- package/esm/src/lib/base64.d.ts.map +1 -1
- package/esm/src/lib/base64.js +2 -2
- package/esm/src/lib/base64.js.map +1 -1
- package/esm/src/lib/config.d.ts +3 -3
- package/esm/src/lib/config.js +5 -5
- package/esm/src/lib/config.js.map +1 -1
- package/esm/src/lib/encodings.d.ts.map +1 -1
- package/esm/src/lib/encodings.js +10 -1
- package/esm/src/lib/encodings.js.map +1 -1
- package/esm/src/lib/matchers.d.ts.map +1 -1
- package/esm/src/lib/matchers.js +4 -1
- package/esm/src/lib/matchers.js.map +1 -1
- package/esm/src/lib/schemas.d.ts +4 -4
- package/esm/src/lib/schemas.d.ts.map +1 -1
- package/esm/src/lib/schemas.js +2 -2
- package/esm/src/lib/schemas.js.map +1 -1
- package/esm/src/lib/sdks.js +2 -2
- package/esm/src/lib/sdks.js.map +1 -1
- package/esm/src/lib/security.d.ts.map +1 -1
- package/esm/src/lib/security.js +18 -0
- package/esm/src/lib/security.js.map +1 -1
- package/esm/src/mcp-server/cli/start/command.d.ts.map +1 -1
- package/esm/src/mcp-server/cli/start/command.js +30 -0
- package/esm/src/mcp-server/cli/start/command.js.map +1 -1
- package/esm/src/mcp-server/cli/start/impl.d.ts +2 -7
- package/esm/src/mcp-server/cli/start/impl.d.ts.map +1 -1
- package/esm/src/mcp-server/cli/start/impl.js +98 -22
- package/esm/src/mcp-server/cli/start/impl.js.map +1 -1
- package/esm/src/mcp-server/extensions.d.ts +4 -4
- package/esm/src/mcp-server/extensions.d.ts.map +1 -1
- package/esm/src/mcp-server/flags.d.ts +17 -0
- package/esm/src/mcp-server/flags.d.ts.map +1 -0
- package/esm/src/mcp-server/flags.js +5 -0
- package/esm/src/mcp-server/flags.js.map +1 -0
- package/esm/src/mcp-server/mcp-server.js +1 -1
- package/esm/src/mcp-server/mcp-server.js.map +1 -1
- package/esm/src/mcp-server/prompts.d.ts +4 -7
- package/esm/src/mcp-server/prompts.d.ts.map +1 -1
- package/esm/src/mcp-server/prompts.js.map +1 -1
- package/esm/src/mcp-server/server.d.ts +8 -1
- package/esm/src/mcp-server/server.d.ts.map +1 -1
- package/esm/src/mcp-server/server.js +19 -16
- package/esm/src/mcp-server/server.js.map +1 -1
- package/esm/src/mcp-server/tools/aiSearch.d.ts +7 -0
- package/esm/src/mcp-server/tools/aiSearch.d.ts.map +1 -0
- package/esm/src/mcp-server/tools/aiSearch.js +83 -0
- package/esm/src/mcp-server/tools/aiSearch.js.map +1 -0
- package/esm/src/mcp-server/tools/getAnnouncementArticles.d.ts +7 -0
- package/esm/src/mcp-server/tools/getAnnouncementArticles.d.ts.map +1 -0
- package/esm/src/mcp-server/tools/getAnnouncementArticles.js +81 -0
- package/esm/src/mcp-server/tools/getAnnouncementArticles.js.map +1 -0
- package/esm/src/mcp-server/tools/getAnnouncements.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/getAnnouncements.js +39 -1
- package/esm/src/mcp-server/tools/getAnnouncements.js.map +1 -1
- package/esm/src/mcp-server/tools/getArticle.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/getArticle.js +42 -0
- package/esm/src/mcp-server/tools/getArticle.js.map +1 -1
- package/esm/src/mcp-server/tools/getArticleById.d.ts +7 -0
- package/esm/src/mcp-server/tools/getArticleById.d.ts.map +1 -0
- package/esm/src/mcp-server/tools/getArticleById.js +90 -0
- package/esm/src/mcp-server/tools/getArticleById.js.map +1 -0
- package/esm/src/mcp-server/tools/getBestAnswer.d.ts +7 -0
- package/esm/src/mcp-server/tools/getBestAnswer.d.ts.map +1 -0
- package/esm/src/mcp-server/tools/getBestAnswer.js +85 -0
- package/esm/src/mcp-server/tools/getBestAnswer.js.map +1 -0
- package/esm/src/mcp-server/tools/getMyPortals.d.ts +7 -0
- package/esm/src/mcp-server/tools/getMyPortals.d.ts.map +1 -0
- package/esm/src/mcp-server/tools/getMyPortals.js +117 -0
- package/esm/src/mcp-server/tools/getMyPortals.js.map +1 -0
- package/esm/src/mcp-server/tools/getPopularArticles.d.ts +1 -1
- package/esm/src/mcp-server/tools/getPopularArticles.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/getPopularArticles.js +40 -0
- package/esm/src/mcp-server/tools/getPopularArticles.js.map +1 -1
- package/esm/src/mcp-server/tools/getPortals.d.ts +1 -1
- package/esm/src/mcp-server/tools/getPortals.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/getPortals.js +26 -1
- package/esm/src/mcp-server/tools/getPortals.js.map +1 -1
- package/esm/src/mcp-server/tools/makeSuggestion.d.ts +1 -1
- package/esm/src/mcp-server/tools/makeSuggestion.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/makeSuggestion.js +44 -0
- package/esm/src/mcp-server/tools/makeSuggestion.js.map +1 -1
- package/esm/src/mcp-server/tools/queryAnswers.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/queryAnswers.js +41 -5
- package/esm/src/mcp-server/tools/queryAnswers.js.map +1 -1
- package/esm/src/mcp-server/tools/queryRetrieve.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/queryRetrieve.js +41 -1
- package/esm/src/mcp-server/tools/queryRetrieve.js.map +1 -1
- package/esm/src/mcp-server/tools/querySearch.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/querySearch.js +48 -1
- package/esm/src/mcp-server/tools/querySearch.js.map +1 -1
- package/esm/src/mcp-server/tools/retrieveChunks.d.ts +1 -1
- package/esm/src/mcp-server/tools/retrieveChunks.d.ts.map +1 -1
- package/esm/src/mcp-server/tools/retrieveChunks.js +41 -7
- package/esm/src/mcp-server/tools/retrieveChunks.js.map +1 -1
- package/esm/src/mcp-server/tools.d.ts +14 -4
- package/esm/src/mcp-server/tools.d.ts.map +1 -1
- package/esm/src/mcp-server/tools.js +203 -5
- package/esm/src/mcp-server/tools.js.map +1 -1
- package/esm/src/models/acceptlanguage.d.ts +36 -5
- package/esm/src/models/acceptlanguage.d.ts.map +1 -1
- package/esm/src/models/acceptlanguage.js +18 -4
- package/esm/src/models/acceptlanguage.js.map +1 -1
- package/esm/src/models/accessibleportal.d.ts +1 -1
- package/esm/src/models/accessibleportal.d.ts.map +1 -1
- package/esm/src/models/accessibleportal.js.map +1 -1
- package/esm/src/models/additionalsnippets.d.ts +18 -3
- package/esm/src/models/additionalsnippets.d.ts.map +1 -1
- package/esm/src/models/additionalsnippets.js +8 -1
- package/esm/src/models/additionalsnippets.js.map +1 -1
- package/esm/src/models/aisearchop.d.ts +4 -10
- package/esm/src/models/aisearchop.d.ts.map +1 -1
- package/esm/src/models/aisearchop.js +9 -20
- package/esm/src/models/aisearchop.js.map +1 -1
- package/esm/src/models/aisearchresponse.d.ts +2 -2
- package/esm/src/models/aisearchresponse.d.ts.map +1 -1
- package/esm/src/models/aisearchresponse.js.map +1 -1
- package/esm/src/models/aispaginationinfo.d.ts +1 -1
- package/esm/src/models/aispaginationinfo.d.ts.map +1 -1
- package/esm/src/models/aispaginationinfo.js +5 -4
- package/esm/src/models/aispaginationinfo.js.map +1 -1
- package/esm/src/models/aitopicbreadcrumb.d.ts +1 -1
- package/esm/src/models/aitopicbreadcrumb.d.ts.map +1 -1
- package/esm/src/models/aitopicbreadcrumb.js +2 -1
- package/esm/src/models/aitopicbreadcrumb.js.map +1 -1
- package/esm/src/models/aitopicsummary.d.ts +1 -1
- package/esm/src/models/aitopicsummary.d.ts.map +1 -1
- package/esm/src/models/aitopicsummary.js.map +1 -1
- package/esm/src/models/allaccessibleportals.d.ts +1 -1
- package/esm/src/models/allaccessibleportals.d.ts.map +1 -1
- package/esm/src/models/allaccessibleportals.js +2 -1
- package/esm/src/models/allaccessibleportals.js.map +1 -1
- package/esm/src/models/answersrequest.d.ts +16 -25
- package/esm/src/models/answersrequest.d.ts.map +1 -1
- package/esm/src/models/answersrequest.js +11 -25
- package/esm/src/models/answersrequest.js.map +1 -1
- package/esm/src/models/answersresponse.d.ts +28 -7
- package/esm/src/models/answersresponse.d.ts.map +1 -1
- package/esm/src/models/answersresponse.js +8 -0
- package/esm/src/models/answersresponse.js.map +1 -1
- package/esm/src/models/article.d.ts +2 -2
- package/esm/src/models/article.d.ts.map +1 -1
- package/esm/src/models/article.js +3 -4
- package/esm/src/models/article.js.map +1 -1
- package/esm/src/models/articleadditionalattributes.d.ts +36 -2
- package/esm/src/models/articleadditionalattributes.d.ts.map +1 -1
- package/esm/src/models/articleadditionalattributes.js +17 -0
- package/esm/src/models/articleadditionalattributes.js.map +1 -1
- package/esm/src/models/articleaisearchresult.d.ts +48 -9
- package/esm/src/models/articleaisearchresult.d.ts.map +1 -1
- package/esm/src/models/articleaisearchresult.js +17 -1
- package/esm/src/models/articleaisearchresult.js.map +1 -1
- package/esm/src/models/articleattachment.d.ts +14 -3
- package/esm/src/models/articleattachment.d.ts.map +1 -1
- package/esm/src/models/articleattachment.js +7 -2
- package/esm/src/models/articleattachment.js.map +1 -1
- package/esm/src/models/articleresult.d.ts +1 -1
- package/esm/src/models/articleresult.d.ts.map +1 -1
- package/esm/src/models/articleresult.js +1 -1
- package/esm/src/models/articleresult.js.map +1 -1
- package/esm/src/models/articleresultadditionalattributes.d.ts +34 -2
- package/esm/src/models/articleresultadditionalattributes.d.ts.map +1 -1
- package/esm/src/models/articleresultadditionalattributes.js +16 -0
- package/esm/src/models/articleresultadditionalattributes.js.map +1 -1
- package/esm/src/models/articleresults.d.ts +1 -1
- package/esm/src/models/articleresults.d.ts.map +1 -1
- package/esm/src/models/articleresults.js.map +1 -1
- package/esm/src/models/articletype.d.ts +2 -7
- package/esm/src/models/articletype.d.ts.map +1 -1
- package/esm/src/models/articletype.js +2 -16
- package/esm/src/models/articletype.js.map +1 -1
- package/esm/src/models/attachmentforcreatesuggestion.d.ts +1 -1
- package/esm/src/models/attachmentforcreatesuggestion.d.ts.map +1 -1
- package/esm/src/models/attachmentforcreatesuggestion.js.map +1 -1
- package/esm/src/models/bookmarkstatus.d.ts +1 -1
- package/esm/src/models/bookmarkstatus.d.ts.map +1 -1
- package/esm/src/models/bookmarkstatus.js +1 -1
- package/esm/src/models/bookmarkstatus.js.map +1 -1
- package/esm/src/models/complianceforarticle.d.ts +3 -3
- package/esm/src/models/complianceforarticle.d.ts.map +1 -1
- package/esm/src/models/complianceforarticle.js +8 -5
- package/esm/src/models/complianceforarticle.js.map +1 -1
- package/esm/src/models/createdby.d.ts +1 -1
- package/esm/src/models/createdby.d.ts.map +1 -1
- package/esm/src/models/createdby.js.map +1 -1
- package/esm/src/models/createsuggestion.d.ts +69 -6
- package/esm/src/models/createsuggestion.d.ts.map +1 -1
- package/esm/src/models/createsuggestion.js +31 -2
- package/esm/src/models/createsuggestion.js.map +1 -1
- package/esm/src/models/customattribute.d.ts +18 -3
- package/esm/src/models/customattribute.d.ts.map +1 -1
- package/esm/src/models/customattribute.js +6 -0
- package/esm/src/models/customattribute.js.map +1 -1
- package/esm/src/models/department.d.ts +1 -1
- package/esm/src/models/department.d.ts.map +1 -1
- package/esm/src/models/department.js.map +1 -1
- package/esm/src/models/edition.d.ts +2 -2
- package/esm/src/models/edition.d.ts.map +1 -1
- package/esm/src/models/edition.js +1 -2
- package/esm/src/models/edition.js.map +1 -1
- package/esm/src/models/errors/sdkvalidationerror.d.ts +1 -1
- package/esm/src/models/errors/sdkvalidationerror.d.ts.map +1 -1
- package/esm/src/models/errors/sdkvalidationerror.js +2 -49
- package/esm/src/models/errors/sdkvalidationerror.js.map +1 -1
- package/esm/src/models/folderbreadcrumb.d.ts +1 -1
- package/esm/src/models/folderbreadcrumb.d.ts.map +1 -1
- package/esm/src/models/folderbreadcrumb.js.map +1 -1
- package/esm/src/models/foldersummary.d.ts +1 -1
- package/esm/src/models/foldersummary.d.ts.map +1 -1
- package/esm/src/models/foldersummary.js +1 -1
- package/esm/src/models/foldersummary.js.map +1 -1
- package/esm/src/models/getannouncementarticlesop.d.ts +8 -9
- package/esm/src/models/getannouncementarticlesop.d.ts.map +1 -1
- package/esm/src/models/getannouncementarticlesop.js +12 -10
- package/esm/src/models/getannouncementarticlesop.js.map +1 -1
- package/esm/src/models/getarticlebyidop.d.ts +77 -11
- package/esm/src/models/getarticlebyidop.d.ts.map +1 -1
- package/esm/src/models/getarticlebyidop.js +31 -62
- package/esm/src/models/getarticlebyidop.js.map +1 -1
- package/esm/src/models/getbestanswerop.d.ts +1 -9
- package/esm/src/models/getbestanswerop.d.ts.map +1 -1
- package/esm/src/models/getbestanswerop.js +3 -16
- package/esm/src/models/getbestanswerop.js.map +1 -1
- package/esm/src/models/getmyportalsop.d.ts +4 -10
- package/esm/src/models/getmyportalsop.d.ts.map +1 -1
- package/esm/src/models/getmyportalsop.js +9 -10
- package/esm/src/models/getmyportalsop.js.map +1 -1
- package/esm/src/models/getpopulararticlesop.d.ts +8 -9
- package/esm/src/models/getpopulararticlesop.d.ts.map +1 -1
- package/esm/src/models/getpopulararticlesop.js +12 -10
- package/esm/src/models/getpopulararticlesop.js.map +1 -1
- package/esm/src/models/l10nstring.d.ts +1 -1
- package/esm/src/models/l10nstring.d.ts.map +1 -1
- package/esm/src/models/l10nstring.js.map +1 -1
- package/esm/src/models/languagecode.d.ts +69 -2
- package/esm/src/models/languagecode.d.ts.map +1 -1
- package/esm/src/models/languagecode.js +32 -0
- package/esm/src/models/languagecode.js.map +1 -1
- package/esm/src/models/languagecodeparameter.d.ts +90 -5
- package/esm/src/models/languagecodeparameter.d.ts.map +1 -1
- package/esm/src/models/languagecodeparameter.js +45 -4
- package/esm/src/models/languagecodeparameter.js.map +1 -1
- package/esm/src/models/languagequeryparameter.d.ts +90 -5
- package/esm/src/models/languagequeryparameter.d.ts.map +1 -1
- package/esm/src/models/languagequeryparameter.js +45 -4
- package/esm/src/models/languagequeryparameter.js.map +1 -1
- package/esm/src/models/link.d.ts +1 -1
- package/esm/src/models/link.d.ts.map +1 -1
- package/esm/src/models/link.js.map +1 -1
- package/esm/src/models/makesuggestionop.d.ts +4 -9
- package/esm/src/models/makesuggestionop.d.ts.map +1 -1
- package/esm/src/models/makesuggestionop.js +3 -7
- package/esm/src/models/makesuggestionop.js.map +1 -1
- package/esm/src/models/mandatorylanguagequeryparameter.d.ts +90 -5
- package/esm/src/models/mandatorylanguagequeryparameter.d.ts.map +1 -1
- package/esm/src/models/mandatorylanguagequeryparameter.js +45 -4
- package/esm/src/models/mandatorylanguagequeryparameter.js.map +1 -1
- package/esm/src/models/milestone.d.ts +1 -1
- package/esm/src/models/milestone.d.ts.map +1 -1
- package/esm/src/models/milestone.js.map +1 -1
- package/esm/src/models/milestonename.d.ts +1 -1
- package/esm/src/models/milestonename.d.ts.map +1 -1
- package/esm/src/models/milestonename.js.map +1 -1
- package/esm/src/models/modifiedby.d.ts +1 -1
- package/esm/src/models/modifiedby.d.ts.map +1 -1
- package/esm/src/models/modifiedby.js.map +1 -1
- package/esm/src/models/order.d.ts +10 -2
- package/esm/src/models/order.d.ts.map +1 -1
- package/esm/src/models/order.js +4 -0
- package/esm/src/models/order.js.map +1 -1
- package/esm/src/models/ownedby.d.ts +1 -1
- package/esm/src/models/ownedby.d.ts.map +1 -1
- package/esm/src/models/ownedby.js +1 -2
- package/esm/src/models/ownedby.js.map +1 -1
- package/esm/src/models/paginationinfo.d.ts +1 -1
- package/esm/src/models/paginationinfo.d.ts.map +1 -1
- package/esm/src/models/paginationinfo.js +3 -3
- package/esm/src/models/paginationinfo.js.map +1 -1
- package/esm/src/models/personalization.d.ts +4 -4
- package/esm/src/models/personalization.d.ts.map +1 -1
- package/esm/src/models/personalization.js +1 -2
- package/esm/src/models/personalization.js.map +1 -1
- package/esm/src/models/publishview.d.ts +2 -2
- package/esm/src/models/publishview.d.ts.map +1 -1
- package/esm/src/models/publishview.js.map +1 -1
- package/esm/src/models/referenceresponse.d.ts +30 -5
- package/esm/src/models/referenceresponse.d.ts.map +1 -1
- package/esm/src/models/referenceresponse.js +12 -1
- package/esm/src/models/referenceresponse.js.map +1 -1
- package/esm/src/models/requiredlanguagecode.d.ts +71 -2
- package/esm/src/models/requiredlanguagecode.d.ts.map +1 -1
- package/esm/src/models/requiredlanguagecode.js +33 -0
- package/esm/src/models/requiredlanguagecode.js.map +1 -1
- package/esm/src/models/retrievechunksop.d.ts +1 -9
- package/esm/src/models/retrievechunksop.d.ts.map +1 -1
- package/esm/src/models/retrievechunksop.js +1 -15
- package/esm/src/models/retrievechunksop.js.map +1 -1
- package/esm/src/models/retrieverequest.d.ts +15 -4
- package/esm/src/models/retrieverequest.d.ts.map +1 -1
- package/esm/src/models/retrieverequest.js +4 -0
- package/esm/src/models/retrieverequest.js.map +1 -1
- package/esm/src/models/retrieveresponse.d.ts +27 -8
- package/esm/src/models/retrieveresponse.d.ts.map +1 -1
- package/esm/src/models/retrieveresponse.js +8 -1
- package/esm/src/models/retrieveresponse.js.map +1 -1
- package/esm/src/models/schemaslink.d.ts +1 -1
- package/esm/src/models/schemaslink.d.ts.map +1 -1
- package/esm/src/models/schemaslink.js.map +1 -1
- package/esm/src/models/schemastags.d.ts +1 -1
- package/esm/src/models/schemastags.d.ts.map +1 -1
- package/esm/src/models/schemastags.js.map +1 -1
- package/esm/src/models/searchresult.d.ts +40 -5
- package/esm/src/models/searchresult.d.ts.map +1 -1
- package/esm/src/models/searchresult.js +19 -0
- package/esm/src/models/searchresult.js.map +1 -1
- package/esm/src/models/security.d.ts +5 -2
- package/esm/src/models/security.d.ts.map +1 -1
- package/esm/src/models/security.js +5 -3
- package/esm/src/models/security.js.map +1 -1
- package/esm/src/models/shorturl.d.ts +1 -1
- package/esm/src/models/shorturl.d.ts.map +1 -1
- package/esm/src/models/shorturl.js +1 -2
- package/esm/src/models/shorturl.js.map +1 -1
- package/esm/src/models/sortidnamedepartment.d.ts +12 -2
- package/esm/src/models/sortidnamedepartment.d.ts.map +1 -1
- package/esm/src/models/sortidnamedepartment.js +5 -0
- package/esm/src/models/sortidnamedepartment.js.map +1 -1
- package/esm/src/models/stage.d.ts +1 -1
- package/esm/src/models/stage.d.ts.map +1 -1
- package/esm/src/models/stage.js +1 -2
- package/esm/src/models/stage.js.map +1 -1
- package/esm/src/models/structuredauthoringfields.d.ts +1 -1
- package/esm/src/models/structuredauthoringfields.d.ts.map +1 -1
- package/esm/src/models/structuredauthoringfields.js.map +1 -1
- package/esm/src/models/tag.d.ts +1 -1
- package/esm/src/models/tag.d.ts.map +1 -1
- package/esm/src/models/tag.js.map +1 -1
- package/esm/src/models/tagcategory.d.ts +1 -1
- package/esm/src/models/tagcategory.d.ts.map +1 -1
- package/esm/src/models/tagcategory.js.map +1 -1
- package/esm/src/models/taggroup.d.ts +1 -1
- package/esm/src/models/taggroup.d.ts.map +1 -1
- package/esm/src/models/taggroup.js +1 -2
- package/esm/src/models/taggroup.js.map +1 -1
- package/esm/src/models/taggroups.d.ts +1 -1
- package/esm/src/models/taggroups.d.ts.map +1 -1
- package/esm/src/models/taggroups.js.map +1 -1
- package/esm/src/models/tags.d.ts +1 -1
- package/esm/src/models/tags.d.ts.map +1 -1
- package/esm/src/models/tags.js.map +1 -1
- package/esm/src/models/topicbreadcrumb.d.ts +1 -1
- package/esm/src/models/topicbreadcrumb.d.ts.map +1 -1
- package/esm/src/models/topicbreadcrumb.js.map +1 -1
- package/esm/src/models/topicsummary.d.ts +1 -1
- package/esm/src/models/topicsummary.d.ts.map +1 -1
- package/esm/src/models/topicsummary.js.map +1 -1
- package/esm/src/models/workflow.d.ts +1 -1
- package/esm/src/models/workflow.d.ts.map +1 -1
- package/esm/src/models/workflow.js +1 -2
- package/esm/src/models/workflow.js.map +1 -1
- package/esm/src/models/workflowmilestone.d.ts +12 -2
- package/esm/src/models/workflowmilestone.d.ts.map +1 -1
- package/esm/src/models/workflowmilestone.js +5 -0
- package/esm/src/models/workflowmilestone.js.map +1 -1
- package/esm/src/models/wserrorcommon.d.ts +2 -2
- package/esm/src/models/wserrorcommon.d.ts.map +1 -1
- package/esm/src/models/wserrorcommon.js +1 -2
- package/esm/src/models/wserrorcommon.js.map +1 -1
- package/esm/src/tool-names.d.ts +5 -0
- package/esm/src/tool-names.d.ts.map +1 -0
- package/esm/src/tool-names.js +36 -0
- package/esm/src/tool-names.js.map +1 -0
- package/esm/src/types/bigint.d.ts +6 -0
- package/esm/src/types/bigint.d.ts.map +1 -0
- package/esm/src/types/bigint.js +87 -0
- package/esm/src/types/bigint.js.map +1 -0
- package/esm/worker-configuration.d.ts +1 -0
- package/esm/worker-configuration.d.ts.map +1 -1
- package/manifest.json +78 -51
- package/package.json +11 -7
- package/src/cloudflare-worker/cloudflare-worker.ts +22 -9
- package/src/funcs/{querySearch.ts → aiSearch.ts} +49 -2
- package/src/funcs/{getAnnouncements.ts → getAnnouncementArticles.ts} +67 -10
- package/src/funcs/{getArticle.ts → getArticleById.ts} +58 -1
- package/src/funcs/{queryAnswers.ts → getBestAnswer.ts} +52 -14
- package/src/funcs/{getPortals.ts → getMyPortals.ts} +35 -2
- package/src/funcs/getPopularArticles.ts +68 -8
- package/src/funcs/makeSuggestion.ts +67 -9
- package/src/funcs/{queryRetrieve.ts → retrieveChunks.ts} +50 -15
- package/src/hooks/auth-hook.ts +3 -63
- package/src/hooks/registration.ts +3 -18
- package/src/landing-page.ts +1084 -0
- package/src/lib/base64.ts +2 -2
- package/src/lib/config.ts +5 -5
- package/src/lib/encodings.ts +12 -3
- package/src/lib/matchers.ts +5 -1
- package/src/lib/schemas.ts +10 -22
- package/src/lib/sdks.ts +2 -2
- package/src/lib/security.ts +21 -0
- package/src/mcp-server/cli/start/command.ts +31 -0
- package/src/mcp-server/cli/start/impl.ts +118 -31
- package/src/mcp-server/extensions.ts +6 -4
- package/src/mcp-server/flags.ts +21 -0
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/prompts.ts +9 -19
- package/src/mcp-server/server.ts +22 -16
- package/src/mcp-server/tools/aiSearch.ts +92 -0
- package/src/mcp-server/tools/getAnnouncementArticles.ts +90 -0
- package/src/mcp-server/tools/getArticleById.ts +99 -0
- package/src/mcp-server/tools/getBestAnswer.ts +94 -0
- package/src/mcp-server/tools/{getPortals.ts → getMyPortals.ts} +39 -5
- package/src/mcp-server/tools/getPopularArticles.ts +40 -0
- package/src/mcp-server/tools/makeSuggestion.ts +44 -0
- package/src/mcp-server/tools/retrieveChunks.ts +89 -0
- package/src/mcp-server/tools.ts +300 -46
- package/src/models/acceptlanguage.ts +21 -8
- package/src/models/accessibleportal.ts +9 -11
- package/src/models/additionalsnippets.ts +25 -18
- package/src/models/aisearchop.ts +14 -37
- package/src/models/aisearchresponse.ts +7 -13
- package/src/models/aispaginationinfo.ts +7 -10
- package/src/models/aitopicbreadcrumb.ts +4 -7
- package/src/models/aitopicsummary.ts +1 -5
- package/src/models/allaccessibleportals.ts +5 -8
- package/src/models/answersrequest.ts +22 -58
- package/src/models/answersresponse.ts +30 -24
- package/src/models/article.ts +39 -40
- package/src/models/articleadditionalattributes.ts +22 -4
- package/src/models/articleaisearchresult.ts +70 -52
- package/src/models/articleattachment.ts +18 -15
- package/src/models/articleresult.ts +2 -6
- package/src/models/articleresultadditionalattributes.ts +43 -0
- package/src/models/articleresults.ts +1 -5
- package/src/models/articletype.ts +4 -25
- package/src/models/attachmentforcreatesuggestion.ts +1 -3
- package/src/models/bookmarkstatus.ts +2 -6
- package/src/models/complianceforarticle.ts +13 -22
- package/src/models/createdby.ts +7 -8
- package/src/models/createsuggestion.ts +54 -31
- package/src/models/customattribute.ts +13 -7
- package/src/models/department.ts +1 -5
- package/src/models/edition.ts +8 -13
- package/src/models/errors/sdkvalidationerror.ts +2 -57
- package/src/models/folderbreadcrumb.ts +5 -7
- package/src/models/foldersummary.ts +2 -6
- package/src/models/getannouncementarticlesop.ts +34 -23
- package/src/models/getarticlebyidop.ts +91 -95
- package/src/models/getbestanswerop.ts +16 -48
- package/src/models/getmyportalsop.ts +29 -44
- package/src/models/getpopulararticlesop.ts +34 -23
- package/src/models/l10nstring.ts +1 -5
- package/src/models/languagecode.ts +38 -2
- package/src/models/languagecodeparameter.ts +48 -10
- package/src/models/languagequeryparameter.ts +48 -10
- package/src/models/link.ts +1 -1
- package/src/models/makesuggestionop.ts +20 -30
- package/src/models/mandatorylanguagequeryparameter.ts +50 -10
- package/src/models/milestone.ts +3 -4
- package/src/models/milestonename.ts +1 -5
- package/src/models/modifiedby.ts +1 -5
- package/src/models/order.ts +7 -2
- package/src/models/ownedby.ts +7 -8
- package/src/models/paginationinfo.ts +4 -8
- package/src/models/personalization.ts +6 -19
- package/src/models/publishview.ts +2 -8
- package/src/models/referenceresponse.ts +34 -20
- package/src/models/requiredlanguagecode.ts +39 -4
- package/src/models/retrievechunksop.ts +16 -48
- package/src/models/retrieverequest.ts +12 -10
- package/src/models/retrieveresponse.ts +34 -28
- package/src/models/schemaslink.ts +1 -5
- package/src/models/schemastags.ts +1 -5
- package/src/models/searchresult.ts +34 -8
- package/src/models/security.ts +14 -7
- package/src/models/shorturl.ts +6 -7
- package/src/models/sortidnamedepartment.ts +8 -4
- package/src/models/stage.ts +4 -5
- package/src/models/structuredauthoringfields.ts +1 -3
- package/src/models/tag.ts +1 -1
- package/src/models/tagcategory.ts +1 -5
- package/src/models/taggroup.ts +4 -5
- package/src/models/taggroups.ts +3 -4
- package/src/models/tags.ts +1 -1
- package/src/models/topicbreadcrumb.ts +1 -5
- package/src/models/topicsummary.ts +1 -5
- package/src/models/workflow.ts +3 -4
- package/src/models/workflowmilestone.ts +8 -2
- package/src/models/wserrorcommon.ts +5 -10
- package/src/tool-names.ts +35 -0
- package/src/types/bigint.ts +87 -0
- package/tsconfig.json +0 -1
- package/worker-configuration.d.ts +2 -2
- package/worker-configuration.ts +1 -0
- package/src/cloudflare-worker/landing-page.ts +0 -337
- package/src/hooks/portal-cache-hook.ts +0 -505
- package/src/hooks/portal-lookup-hook.ts +0 -429
- package/src/mcp-server/tools/getAnnouncements.ts +0 -53
- package/src/mcp-server/tools/getArticle.ts +0 -56
- package/src/mcp-server/tools/queryAnswers.ts +0 -57
- package/src/mcp-server/tools/queryRetrieve.ts +0 -55
- package/src/mcp-server/tools/querySearch.ts +0 -44
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"customattribute.d.ts","sourceRoot":"","sources":["../../../src/models/customattribute.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"customattribute.d.ts","sourceRoot":"","sources":["../../../src/models/customattribute.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;CAKtB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEzE,eAAO,MAAM,6BAA6B;;;;;EAKC,CAAC;AAE5C,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAClC,IAAI,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;CACxC,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAI/D,CAAC"}
|
|
@@ -5,6 +5,12 @@ import * as z from "zod";
|
|
|
5
5
|
/**
|
|
6
6
|
* The custom attribute's type.
|
|
7
7
|
*/
|
|
8
|
+
export const CustomAttributeType = {
|
|
9
|
+
String: "STRING",
|
|
10
|
+
Integer: "INTEGER",
|
|
11
|
+
Boolean: "BOOLEAN",
|
|
12
|
+
Datetime: "DATETIME",
|
|
13
|
+
};
|
|
8
14
|
export const CustomAttributeType$zodSchema = z.enum([
|
|
9
15
|
"STRING",
|
|
10
16
|
"INTEGER",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"customattribute.js","sourceRoot":"","sources":["../../../src/models/customattribute.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"customattribute.js","sourceRoot":"","sources":["../../../src/models/customattribute.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAMX,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,IAAI,CAAC;IAClD,QAAQ;IACR,SAAS;IACT,SAAS;IACT,UAAU;CACX,CAAC,CAAC,QAAQ,CAAC,8BAA8B,CAAC,CAAC;AAQ5C,MAAM,CAAC,MAAM,yBAAyB,GAA+B,CAAC,CAAC,MAAM,CAAC;IAC5E,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,IAAI,EAAE,6BAA6B,CAAC,QAAQ,EAAE;IAC9C,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAC"}
|
|
@@ -3,5 +3,5 @@ export type Department = {
|
|
|
3
3
|
id?: string | undefined;
|
|
4
4
|
name?: string | undefined;
|
|
5
5
|
};
|
|
6
|
-
export declare const Department$zodSchema: z.ZodType<Department
|
|
6
|
+
export declare const Department$zodSchema: z.ZodType<Department>;
|
|
7
7
|
//# sourceMappingURL=department.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"department.d.ts","sourceRoot":"","sources":["../../../src/models/department.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,MAAM,UAAU,GAAG;IAAE,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEhF,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,
|
|
1
|
+
{"version":3,"file":"department.d.ts","sourceRoot":"","sources":["../../../src/models/department.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,MAAM,UAAU,GAAG;IAAE,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEhF,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAGrD,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"department.js","sourceRoot":"","sources":["../../../src/models/department.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB,MAAM,CAAC,MAAM,oBAAoB,
|
|
1
|
+
{"version":3,"file":"department.js","sourceRoot":"","sources":["../../../src/models/department.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB,MAAM,CAAC,MAAM,oBAAoB,GAA0B,CAAC,CAAC,MAAM,CAAC;IAClE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC"}
|
|
@@ -7,7 +7,7 @@ export type PublishProfile = {
|
|
|
7
7
|
id: string;
|
|
8
8
|
name: string;
|
|
9
9
|
};
|
|
10
|
-
export declare const PublishProfile$zodSchema: z.ZodType<PublishProfile
|
|
10
|
+
export declare const PublishProfile$zodSchema: z.ZodType<PublishProfile>;
|
|
11
11
|
/**
|
|
12
12
|
* This schema contains information about an article edition.
|
|
13
13
|
*/
|
|
@@ -18,5 +18,5 @@ export type Edition = {
|
|
|
18
18
|
publishProfile?: PublishProfile | undefined;
|
|
19
19
|
link?: Link | undefined;
|
|
20
20
|
};
|
|
21
|
-
export declare const Edition$zodSchema: z.ZodType<Edition
|
|
21
|
+
export declare const Edition$zodSchema: z.ZodType<Edition>;
|
|
22
22
|
//# sourceMappingURL=edition.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"edition.d.ts","sourceRoot":"","sources":["../../../src/models/edition.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,IAAI,EAAkB,MAAM,WAAW,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1D,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,
|
|
1
|
+
{"version":3,"file":"edition.d.ts","sourceRoot":"","sources":["../../../src/models/edition.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,IAAI,EAAkB,MAAM,WAAW,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1D,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAAC,cAAc,CAGF,CAAC;AAE9D;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAC5C,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAMwB,CAAC"}
|
|
@@ -7,8 +7,7 @@ export const PublishProfile$zodSchema = z.object({
|
|
|
7
7
|
id: z.string(),
|
|
8
8
|
name: z.string(),
|
|
9
9
|
}).describe("The publish view associated with this edition.");
|
|
10
|
-
export const Edition$zodSchema = z
|
|
11
|
-
.object({
|
|
10
|
+
export const Edition$zodSchema = z.object({
|
|
12
11
|
id: z.string().optional(),
|
|
13
12
|
isContentEdition: z.boolean().optional(),
|
|
14
13
|
link: Link$zodSchema.optional(),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"edition.js","sourceRoot":"","sources":["../../../src/models/edition.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAQ,cAAc,EAAE,MAAM,WAAW,CAAC;AAOjD,MAAM,CAAC,MAAM,wBAAwB,
|
|
1
|
+
{"version":3,"file":"edition.js","sourceRoot":"","sources":["../../../src/models/edition.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAQ,cAAc,EAAE,MAAM,WAAW,CAAC;AAOjD,MAAM,CAAC,MAAM,wBAAwB,GAA8B,CAAC,CAAC,MAAM,CAAC;IAC1E,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAC,QAAQ,CAAC,gDAAgD,CAAC,CAAC;AAa9D,MAAM,CAAC,MAAM,iBAAiB,GAAuB,CAAC,CAAC,MAAM,CAAC;IAC5D,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACxC,IAAI,EAAE,cAAc,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,CAAC,QAAQ,EAAE;CAClE,CAAC,CAAC,QAAQ,CAAC,4DAA4D,CAAC,CAAC"}
|
|
@@ -16,5 +16,5 @@ export declare class SDKValidationError extends Error {
|
|
|
16
16
|
*/
|
|
17
17
|
pretty(): string;
|
|
18
18
|
}
|
|
19
|
-
export declare function formatZodError(err: z.ZodError
|
|
19
|
+
export declare function formatZodError(err: z.ZodError): string;
|
|
20
20
|
//# sourceMappingURL=sdkvalidationerror.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdkvalidationerror.d.ts","sourceRoot":"","sources":["../../../../src/models/errors/sdkvalidationerror.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C;;OAEG;IACH,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;gBAExB,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO;IAQ9D;;;;OAIG;IACI,MAAM,IAAI,MAAM;CAOxB;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,
|
|
1
|
+
{"version":3,"file":"sdkvalidationerror.d.ts","sourceRoot":"","sources":["../../../../src/models/errors/sdkvalidationerror.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C;;OAEG;IACH,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;gBAExB,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO;IAQ9D;;;;OAIG;IACI,MAAM,IAAI,MAAM;CAOxB;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,GAAG,MAAM,CAEtD"}
|
|
@@ -32,54 +32,7 @@ export class SDKValidationError extends Error {
|
|
|
32
32
|
}
|
|
33
33
|
}
|
|
34
34
|
}
|
|
35
|
-
export function formatZodError(err
|
|
36
|
-
|
|
37
|
-
pre = level > 0 ? `│${pre}` : pre;
|
|
38
|
-
pre += " ".repeat(level);
|
|
39
|
-
let message = "";
|
|
40
|
-
const append = (str) => (message += `\n${pre}${str}`);
|
|
41
|
-
const len = err.issues.length;
|
|
42
|
-
const headline = len === 1 ? `${len} issue found` : `${len} issues found`;
|
|
43
|
-
if (len) {
|
|
44
|
-
append(`┌ ${headline}:`);
|
|
45
|
-
}
|
|
46
|
-
for (const issue of err.issues) {
|
|
47
|
-
let path = issue.path.join(".");
|
|
48
|
-
path = path ? `<root>.${path}` : "<root>";
|
|
49
|
-
append(`│ • [${path}]: ${issue.message} (${issue.code})`);
|
|
50
|
-
switch (issue.code) {
|
|
51
|
-
case "invalid_literal":
|
|
52
|
-
case "invalid_type": {
|
|
53
|
-
append(`│ Want: ${issue.expected}`);
|
|
54
|
-
append(`│ Got: ${issue.received}`);
|
|
55
|
-
break;
|
|
56
|
-
}
|
|
57
|
-
case "unrecognized_keys": {
|
|
58
|
-
append(`│ Keys: ${issue.keys.join(", ")}`);
|
|
59
|
-
break;
|
|
60
|
-
}
|
|
61
|
-
case "invalid_enum_value": {
|
|
62
|
-
append(`│ Allowed: ${issue.options.join(", ")}`);
|
|
63
|
-
append(`│ Got: ${issue.received}`);
|
|
64
|
-
break;
|
|
65
|
-
}
|
|
66
|
-
case "invalid_union_discriminator": {
|
|
67
|
-
append(`│ Allowed: ${issue.options.join(", ")}`);
|
|
68
|
-
break;
|
|
69
|
-
}
|
|
70
|
-
case "invalid_union": {
|
|
71
|
-
const len = issue.unionErrors.length;
|
|
72
|
-
append(`│ ✖︎ Attemped to deserialize into one of ${len} union members:`);
|
|
73
|
-
issue.unionErrors.forEach((err, i) => {
|
|
74
|
-
append(`│ ✖︎ Member ${i + 1} of ${len}`);
|
|
75
|
-
append(`${formatZodError(err, level + 1)}`);
|
|
76
|
-
});
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
}
|
|
80
|
-
if (err.issues.length) {
|
|
81
|
-
append(`└─*`);
|
|
82
|
-
}
|
|
83
|
-
return message.slice(1);
|
|
35
|
+
export function formatZodError(err) {
|
|
36
|
+
return z.prettifyError(err);
|
|
84
37
|
}
|
|
85
38
|
//# sourceMappingURL=sdkvalidationerror.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdkvalidationerror.js","sourceRoot":"","sources":["../../../../src/models/errors/sdkvalidationerror.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C;;OAEG;IACa,QAAQ,CAAU;IAElC;;OAEG;IACa,UAAU,CAAU;IAEpC,YAAY,OAAe,EAAE,KAAc,EAAE,QAAiB;QAC5D,KAAK,CAAC,GAAG,OAAO,KAAK,KAAK,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM;QACX,IAAI,IAAI,CAAC,KAAK,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;YACrC,OAAO,GAAG,IAAI,CAAC,UAAU,KAAK,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7D,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;CACF;AAED,MAAM,UAAU,cAAc,CAAC,GAAe
|
|
1
|
+
{"version":3,"file":"sdkvalidationerror.js","sourceRoot":"","sources":["../../../../src/models/errors/sdkvalidationerror.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C;;OAEG;IACa,QAAQ,CAAU;IAElC;;OAEG;IACa,UAAU,CAAU;IAEpC,YAAY,OAAe,EAAE,KAAc,EAAE,QAAiB;QAC5D,KAAK,CAAC,GAAG,OAAO,KAAK,KAAK,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM;QACX,IAAI,IAAI,CAAC,KAAK,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;YACrC,OAAO,GAAG,IAAI,CAAC,UAAU,KAAK,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7D,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;CACF;AAED,MAAM,UAAU,cAAc,CAAC,GAAe;IAC5C,OAAO,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;AAC9B,CAAC"}
|
|
@@ -6,5 +6,5 @@ import { FolderSummary } from "./foldersummary.js";
|
|
|
6
6
|
export type FolderBreadcrumb = {
|
|
7
7
|
folderSummary?: Array<FolderSummary> | undefined;
|
|
8
8
|
};
|
|
9
|
-
export declare const FolderBreadcrumb$zodSchema: z.ZodType<FolderBreadcrumb
|
|
9
|
+
export declare const FolderBreadcrumb$zodSchema: z.ZodType<FolderBreadcrumb>;
|
|
10
10
|
//# sourceMappingURL=folderbreadcrumb.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"folderbreadcrumb.d.ts","sourceRoot":"","sources":["../../../src/models/folderbreadcrumb.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,aAAa,EAA2B,MAAM,oBAAoB,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC;CAClD,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,
|
|
1
|
+
{"version":3,"file":"folderbreadcrumb.d.ts","sourceRoot":"","sources":["../../../src/models/folderbreadcrumb.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,aAAa,EAA2B,MAAM,oBAAoB,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC;CAClD,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAII,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"folderbreadcrumb.js","sourceRoot":"","sources":["../../../src/models/folderbreadcrumb.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAiB,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAS5E,MAAM,CAAC,MAAM,0BAA0B,
|
|
1
|
+
{"version":3,"file":"folderbreadcrumb.js","sourceRoot":"","sources":["../../../src/models/folderbreadcrumb.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAiB,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAS5E,MAAM,CAAC,MAAM,0BAA0B,GAAgC,CAAC,CAAC,MAAM,CAC7E;IACE,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,QAAQ,EAAE;CAC3D,CACF,CAAC,QAAQ,CAAC,2DAA2D,CAAC,CAAC"}
|
|
@@ -8,5 +8,5 @@ export type FolderSummary = {
|
|
|
8
8
|
name?: string | undefined;
|
|
9
9
|
link?: SchemasLink | undefined;
|
|
10
10
|
};
|
|
11
|
-
export declare const FolderSummary$zodSchema: z.ZodType<FolderSummary
|
|
11
|
+
export declare const FolderSummary$zodSchema: z.ZodType<FolderSummary>;
|
|
12
12
|
//# sourceMappingURL=foldersummary.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"foldersummary.d.ts","sourceRoot":"","sources":["../../../src/models/foldersummary.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,WAAW,EAAyB,MAAM,kBAAkB,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,
|
|
1
|
+
{"version":3,"file":"foldersummary.d.ts","sourceRoot":"","sources":["../../../src/models/foldersummary.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,WAAW,EAAyB,MAAM,kBAAkB,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAM5D,CAAC"}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
import * as z from "zod";
|
|
5
5
|
import { SchemasLink$zodSchema } from "./schemaslink.js";
|
|
6
6
|
export const FolderSummary$zodSchema = z.object({
|
|
7
|
-
id: z.
|
|
7
|
+
id: z.int().optional(),
|
|
8
8
|
link: SchemasLink$zodSchema.optional(),
|
|
9
9
|
name: z.string().optional(),
|
|
10
10
|
}).describe("This schema contains the topic ID and name of the Folder. This is used by FolderBreadcrumb.");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"foldersummary.js","sourceRoot":"","sources":["../../../src/models/foldersummary.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAe,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAWtE,MAAM,CAAC,MAAM,uBAAuB,
|
|
1
|
+
{"version":3,"file":"foldersummary.js","sourceRoot":"","sources":["../../../src/models/foldersummary.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAe,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAWtE,MAAM,CAAC,MAAM,uBAAuB,GAA6B,CAAC,CAAC,MAAM,CAAC;IACxE,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACtB,IAAI,EAAE,qBAAqB,CAAC,QAAQ,EAAE;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAC,QAAQ,CACT,6FAA6F,CAC9F,CAAC"}
|
|
@@ -1,25 +1,24 @@
|
|
|
1
1
|
import * as z from "zod";
|
|
2
2
|
import { AcceptLanguage } from "./acceptlanguage.js";
|
|
3
|
+
import { ArticleResultAdditionalAttributes } from "./articleresultadditionalattributes.js";
|
|
3
4
|
import { ArticleResults } from "./articleresults.js";
|
|
4
5
|
import { LanguageQueryParameter } from "./languagequeryparameter.js";
|
|
5
6
|
import { WorkflowMilestone } from "./workflowmilestone.js";
|
|
6
7
|
import { WSErrorCommon } from "./wserrorcommon.js";
|
|
7
8
|
export type GetAnnouncementArticlesRequest = {
|
|
9
|
+
xEgainActivityId?: string | undefined;
|
|
10
|
+
xExtIntegrationId?: string | undefined;
|
|
11
|
+
xExtInteractionId?: string | undefined;
|
|
8
12
|
acceptLanguage?: AcceptLanguage | undefined;
|
|
9
13
|
portalID: string;
|
|
10
14
|
dollarFilterTags?: string | undefined;
|
|
15
|
+
articleResultAdditionalAttributes?: Array<ArticleResultAdditionalAttributes> | undefined;
|
|
11
16
|
workflowMilestone?: WorkflowMilestone | undefined;
|
|
12
17
|
Dollar_lang?: LanguageQueryParameter | undefined;
|
|
13
18
|
Dollar_pagenum?: number | undefined;
|
|
14
19
|
Dollar_pagesize?: number | undefined;
|
|
15
20
|
};
|
|
16
|
-
export declare const GetAnnouncementArticlesRequest$zodSchema: z.ZodType<GetAnnouncementArticlesRequest
|
|
17
|
-
export type GetAnnouncementArticlesResponse =
|
|
18
|
-
|
|
19
|
-
StatusCode: number;
|
|
20
|
-
RawResponse: Response;
|
|
21
|
-
ArticleResults?: ArticleResults | undefined;
|
|
22
|
-
WSErrorCommon?: WSErrorCommon | undefined;
|
|
23
|
-
};
|
|
24
|
-
export declare const GetAnnouncementArticlesResponse$zodSchema: z.ZodType<GetAnnouncementArticlesResponse, z.ZodTypeDef, unknown>;
|
|
21
|
+
export declare const GetAnnouncementArticlesRequest$zodSchema: z.ZodType<GetAnnouncementArticlesRequest>;
|
|
22
|
+
export type GetAnnouncementArticlesResponse = WSErrorCommon | ArticleResults;
|
|
23
|
+
export declare const GetAnnouncementArticlesResponse$zodSchema: z.ZodType<GetAnnouncementArticlesResponse>;
|
|
25
24
|
//# sourceMappingURL=getannouncementarticlesop.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getannouncementarticlesop.d.ts","sourceRoot":"","sources":["../../../src/models/getannouncementarticlesop.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,cAAc,EAA4B,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,cAAc,EAA4B,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EACL,sBAAsB,EAEvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,aAAa,EAA2B,MAAM,oBAAoB,CAAC;AAE5E,MAAM,MAAM,8BAA8B,GAAG;IAC3C,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAClD,WAAW,CAAC,EAAE,sBAAsB,GAAG,SAAS,CAAC;IACjD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,8BAA8B,
|
|
1
|
+
{"version":3,"file":"getannouncementarticlesop.d.ts","sourceRoot":"","sources":["../../../src/models/getannouncementarticlesop.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,cAAc,EAA4B,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EACL,iCAAiC,EAElC,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,cAAc,EAA4B,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EACL,sBAAsB,EAEvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,aAAa,EAA2B,MAAM,oBAAoB,CAAC;AAE5E,MAAM,MAAM,8BAA8B,GAAG;IAC3C,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,iCAAiC,CAAC,EAC9B,KAAK,CAAC,iCAAiC,CAAC,GACxC,SAAS,CAAC;IACd,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAClD,WAAW,CAAC,EAAE,sBAAsB,GAAG,SAAS,CAAC;IACjD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,8BAA8B,CA+B9B,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,aAAa,GAAG,cAAc,CAAC;AAE7E,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,+BAA+B,CAI/B,CAAC"}
|
|
@@ -3,24 +3,26 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as z from "zod";
|
|
5
5
|
import { AcceptLanguage$zodSchema } from "./acceptlanguage.js";
|
|
6
|
+
import { ArticleResultAdditionalAttributes$zodSchema, } from "./articleresultadditionalattributes.js";
|
|
6
7
|
import { ArticleResults$zodSchema } from "./articleresults.js";
|
|
7
8
|
import { LanguageQueryParameter$zodSchema, } from "./languagequeryparameter.js";
|
|
8
9
|
import { WorkflowMilestone$zodSchema, } from "./workflowmilestone.js";
|
|
9
10
|
import { WSErrorCommon$zodSchema } from "./wserrorcommon.js";
|
|
10
11
|
export const GetAnnouncementArticlesRequest$zodSchema = z.object({
|
|
11
|
-
Dollar_lang: LanguageQueryParameter$zodSchema.
|
|
12
|
-
Dollar_pagenum: z.
|
|
13
|
-
Dollar_pagesize: z.
|
|
12
|
+
Dollar_lang: LanguageQueryParameter$zodSchema.optional(),
|
|
13
|
+
Dollar_pagenum: z.int().default(1).describe("Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."),
|
|
14
|
+
Dollar_pagesize: z.int().default(10).describe("Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum."),
|
|
14
15
|
acceptLanguage: AcceptLanguage$zodSchema.default("en-US"),
|
|
16
|
+
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(),
|
|
15
17
|
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(),
|
|
16
18
|
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."),
|
|
17
19
|
workflowMilestone: WorkflowMilestone$zodSchema.optional(),
|
|
20
|
+
xEgainActivityId: z.string().describe("A unique numeric interaction identifier from eGain.").optional(),
|
|
21
|
+
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(),
|
|
22
|
+
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(),
|
|
18
23
|
});
|
|
19
|
-
export const GetAnnouncementArticlesResponse$zodSchema = z.
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
StatusCode: z.number().int(),
|
|
24
|
-
WSErrorCommon: WSErrorCommon$zodSchema.optional(),
|
|
25
|
-
});
|
|
24
|
+
export const GetAnnouncementArticlesResponse$zodSchema = z.union([
|
|
25
|
+
WSErrorCommon$zodSchema,
|
|
26
|
+
ArticleResults$zodSchema,
|
|
27
|
+
]);
|
|
26
28
|
//# sourceMappingURL=getannouncementarticlesop.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getannouncementarticlesop.js","sourceRoot":"","sources":["../../../src/models/getannouncementarticlesop.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAkB,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAkB,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAEL,gCAAgC,GACjC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAEL,2BAA2B,GAC5B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAiB,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"getannouncementarticlesop.js","sourceRoot":"","sources":["../../../src/models/getannouncementarticlesop.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAkB,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAEL,2CAA2C,GAC5C,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAkB,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAEL,gCAAgC,GACjC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAEL,2BAA2B,GAC5B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAiB,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAkB5E,MAAM,CAAC,MAAM,wCAAwC,GAEjD,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,gCAAgC,CAAC,QAAQ,EAAE;IACxD,cAAc,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CACzC,oHAAoH,CACrH;IACD,eAAe,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,QAAQ,CAC3C,wGAAwG,CACzG;IACD,cAAc,EAAE,wBAAwB,CAAC,OAAO,CAAC,OAAO,CAAC;IACzD,iCAAiC,EAAE,CAAC,CAAC,KAAK,CACxC,2CAA2C,CAC5C,CAAC,QAAQ,CACR,4lCAA4lC,CAC7lC,CAAC,QAAQ,EAAE;IACZ,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CACnC,2KAA2K,CAC5K,CAAC,QAAQ,EAAE;IACZ,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAC3B,iIAAiI,CAClI;IACD,iBAAiB,EAAE,2BAA2B,CAAC,QAAQ,EAAE;IACzD,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CACnC,qDAAqD,CACtD,CAAC,QAAQ,EAAE;IACZ,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CACpC,sOAAsO,CACvO,CAAC,QAAQ,EAAE;IACZ,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CACpC,+KAA+K,CAChL,CAAC,QAAQ,EAAE;CACb,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,yCAAyC,GAElD,CAAC,CAAC,KAAK,CAAC;IACV,uBAAuB;IACvB,wBAAwB;CACzB,CAAC,CAAC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import * as z from "zod";
|
|
2
|
+
import { ClosedEnum } from "../types/enums.js";
|
|
2
3
|
import { AcceptLanguage } from "./acceptlanguage.js";
|
|
3
4
|
import { Article } from "./article.js";
|
|
4
5
|
import { ArticleAdditionalAttributes } from "./articleadditionalattributes.js";
|
|
@@ -32,9 +33,80 @@ import { WSErrorCommon } from "./wserrorcommon.js";
|
|
|
32
33
|
* | instant_answer | View an Article via an Instant Answers solution.
|
|
33
34
|
* | instant_answer_reference | View an Article that is used as a reference for an Instant Answers solution.
|
|
34
35
|
*/
|
|
35
|
-
export declare const AccessSource
|
|
36
|
-
|
|
36
|
+
export declare const AccessSource: {
|
|
37
|
+
readonly ArticleView: "article_view";
|
|
38
|
+
readonly ArticleViewMoreRelatedArticle: "article_view_more_related_Article";
|
|
39
|
+
readonly ArticleViewBasicSearch: "article_view_basic_search";
|
|
40
|
+
readonly ArticleViewAdvSearch: "article_view_adv_search";
|
|
41
|
+
readonly ArticleViewGuidedHelp: "article_view_guided_help";
|
|
42
|
+
readonly ArticleViewBrowseTopic: "article_view_browse_topic";
|
|
43
|
+
readonly ArticleViewBrowseTree: "article_view_browse_tree";
|
|
44
|
+
readonly ArticleViewPopularArticles: "article_view_popular_articles";
|
|
45
|
+
readonly ArticleViewUsefulItems: "article_view_useful_items";
|
|
46
|
+
readonly ArticleViewWidget: "article_view_widget";
|
|
47
|
+
readonly ArticleViewAnnouncement: "article_view_announcement";
|
|
48
|
+
readonly ArticleViewBookmarked: "article_view_bookmarked";
|
|
49
|
+
readonly ArticleViewSubscriptionNotification: "article_view_subscription_notification";
|
|
50
|
+
readonly ArticleViewGuidedHelpAdditionalInfo: "article_view_guided_help_additional_info";
|
|
51
|
+
readonly ViewArticlesPendingCompliance: "view_articles_pending_compliance";
|
|
52
|
+
readonly TypeAheadSuggestion: "type_ahead_Suggestion";
|
|
53
|
+
readonly SemanticSuggestion: "semantic_Suggestion";
|
|
54
|
+
readonly InstantAnswer: "instant_answer";
|
|
55
|
+
readonly InstantAnswerReference: "instant_answer_reference";
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
* 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".
|
|
59
|
+
*
|
|
60
|
+
* @remarks
|
|
61
|
+
*
|
|
62
|
+
* | Name | Description
|
|
63
|
+
* | ---- | -----------
|
|
64
|
+
* | article_view | View an Article directly using its ID.
|
|
65
|
+
* | article_view_more_related_Article | View related articles of an Article using its ID.
|
|
66
|
+
* | article_view_basic_search | View an Article via a basic search.
|
|
67
|
+
* | article_view_adv_search | View an Article via an advanced search.
|
|
68
|
+
* | article_view_guided_help | View an Article via a Guided Help solution.
|
|
69
|
+
* | article_view_browse_topic | View an Article via browsing a topic.
|
|
70
|
+
* | article_view_browse_tree | View an Article via browsing a topic tree.
|
|
71
|
+
* | article_view_popular_articles | View an Article using the Popular Items list in the Self-Service portal.
|
|
72
|
+
* | article_view_useful_items | View Article using the Useful Items list in the Self-Service portal.
|
|
73
|
+
* | article_view_widget | View an Article via a widget.
|
|
74
|
+
* | article_view_announcement | View an Article from the announcement section in the Self-Service portal.
|
|
75
|
+
* | article_view_bookmarked | View a bookmarked Article.
|
|
76
|
+
* | article_view_subscription_notification | View an Article from a subscription notification.
|
|
77
|
+
* | article_view_guided_help_additional_info | View an Article via additional information from a Guided Help search.
|
|
78
|
+
* | view_articles_pending_compliance | View an Article via Read & Sign in the Self-Service portal.
|
|
79
|
+
* | type_ahead_Suggestion | View an Article from a type-ahead Suggestion in the Self-Service portal.
|
|
80
|
+
* | semantic_Suggestion | View an Article from a semantic Suggestion in the Self-Service portal.
|
|
81
|
+
* | instant_answer | View an Article via an Instant Answers solution.
|
|
82
|
+
* | instant_answer_reference | View an Article that is used as a reference for an Instant Answers solution.
|
|
83
|
+
*/
|
|
84
|
+
export type AccessSource = ClosedEnum<typeof AccessSource>;
|
|
85
|
+
export declare const AccessSource$zodSchema: z.ZodEnum<{
|
|
86
|
+
article_view: "article_view";
|
|
87
|
+
article_view_more_related_Article: "article_view_more_related_Article";
|
|
88
|
+
article_view_basic_search: "article_view_basic_search";
|
|
89
|
+
article_view_adv_search: "article_view_adv_search";
|
|
90
|
+
article_view_guided_help: "article_view_guided_help";
|
|
91
|
+
article_view_browse_topic: "article_view_browse_topic";
|
|
92
|
+
article_view_browse_tree: "article_view_browse_tree";
|
|
93
|
+
article_view_popular_articles: "article_view_popular_articles";
|
|
94
|
+
article_view_useful_items: "article_view_useful_items";
|
|
95
|
+
article_view_widget: "article_view_widget";
|
|
96
|
+
article_view_announcement: "article_view_announcement";
|
|
97
|
+
article_view_bookmarked: "article_view_bookmarked";
|
|
98
|
+
article_view_subscription_notification: "article_view_subscription_notification";
|
|
99
|
+
article_view_guided_help_additional_info: "article_view_guided_help_additional_info";
|
|
100
|
+
view_articles_pending_compliance: "view_articles_pending_compliance";
|
|
101
|
+
type_ahead_Suggestion: "type_ahead_Suggestion";
|
|
102
|
+
semantic_Suggestion: "semantic_Suggestion";
|
|
103
|
+
instant_answer: "instant_answer";
|
|
104
|
+
instant_answer_reference: "instant_answer_reference";
|
|
105
|
+
}>;
|
|
37
106
|
export type GetArticleByIdRequest = {
|
|
107
|
+
xEgainActivityId?: string | undefined;
|
|
108
|
+
xExtIntegrationId?: string | undefined;
|
|
109
|
+
xExtInteractionId?: string | undefined;
|
|
38
110
|
acceptLanguage?: AcceptLanguage | undefined;
|
|
39
111
|
portalID: string;
|
|
40
112
|
articleID: string;
|
|
@@ -45,13 +117,7 @@ export type GetArticleByIdRequest = {
|
|
|
45
117
|
publishViewId?: string | undefined;
|
|
46
118
|
workflowMilestone?: WorkflowMilestone | undefined;
|
|
47
119
|
};
|
|
48
|
-
export declare const GetArticleByIdRequest$zodSchema: z.ZodType<GetArticleByIdRequest
|
|
49
|
-
export type GetArticleByIdResponse =
|
|
50
|
-
|
|
51
|
-
StatusCode: number;
|
|
52
|
-
RawResponse: Response;
|
|
53
|
-
Article?: Article | undefined;
|
|
54
|
-
WSErrorCommon?: WSErrorCommon | undefined;
|
|
55
|
-
};
|
|
56
|
-
export declare const GetArticleByIdResponse$zodSchema: z.ZodType<GetArticleByIdResponse, z.ZodTypeDef, unknown>;
|
|
120
|
+
export declare const GetArticleByIdRequest$zodSchema: z.ZodType<GetArticleByIdRequest>;
|
|
121
|
+
export type GetArticleByIdResponse = Article | WSErrorCommon;
|
|
122
|
+
export declare const GetArticleByIdResponse$zodSchema: z.ZodType<GetArticleByIdResponse>;
|
|
57
123
|
//# sourceMappingURL=getarticlebyidop.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getarticlebyidop.d.ts","sourceRoot":"","sources":["../../../src/models/getarticlebyidop.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,cAAc,EAA4B,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,OAAO,EAAqB,MAAM,cAAc,CAAC;AAC1D,OAAO,EACL,2BAA2B,EAE5B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,sBAAsB,EAEvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,aAAa,EAA2B,MAAM,oBAAoB,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,
|
|
1
|
+
{"version":3,"file":"getarticlebyidop.d.ts","sourceRoot":"","sources":["../../../src/models/getarticlebyidop.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAA4B,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,OAAO,EAAqB,MAAM,cAAc,CAAC;AAC1D,OAAO,EACL,2BAA2B,EAE5B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,sBAAsB,EAEvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,aAAa,EAA2B,MAAM,oBAAoB,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;CAqBf,CAAC;AACX;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAE3D,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;EAsBlC,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,sBAAsB,GAAG,SAAS,CAAC;IACjD,2BAA2B,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC,GAAG,SAAS,CAAC;IAC7E,iCAAiC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvD,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;CACnD,CAAC;AAEF,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CA6BzE,CAAC;AAEL,MAAM,MAAM,sBAAsB,GAAG,OAAO,GAAG,aAAa,CAAC;AAE7D,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,sBAAsB,CAItB,CAAC"}
|
|
@@ -35,6 +35,27 @@ import { WSErrorCommon$zodSchema } from "./wserrorcommon.js";
|
|
|
35
35
|
* | instant_answer | View an Article via an Instant Answers solution.
|
|
36
36
|
* | instant_answer_reference | View an Article that is used as a reference for an Instant Answers solution.
|
|
37
37
|
*/
|
|
38
|
+
export const AccessSource = {
|
|
39
|
+
ArticleView: "article_view",
|
|
40
|
+
ArticleViewMoreRelatedArticle: "article_view_more_related_Article",
|
|
41
|
+
ArticleViewBasicSearch: "article_view_basic_search",
|
|
42
|
+
ArticleViewAdvSearch: "article_view_adv_search",
|
|
43
|
+
ArticleViewGuidedHelp: "article_view_guided_help",
|
|
44
|
+
ArticleViewBrowseTopic: "article_view_browse_topic",
|
|
45
|
+
ArticleViewBrowseTree: "article_view_browse_tree",
|
|
46
|
+
ArticleViewPopularArticles: "article_view_popular_articles",
|
|
47
|
+
ArticleViewUsefulItems: "article_view_useful_items",
|
|
48
|
+
ArticleViewWidget: "article_view_widget",
|
|
49
|
+
ArticleViewAnnouncement: "article_view_announcement",
|
|
50
|
+
ArticleViewBookmarked: "article_view_bookmarked",
|
|
51
|
+
ArticleViewSubscriptionNotification: "article_view_subscription_notification",
|
|
52
|
+
ArticleViewGuidedHelpAdditionalInfo: "article_view_guided_help_additional_info",
|
|
53
|
+
ViewArticlesPendingCompliance: "view_articles_pending_compliance",
|
|
54
|
+
TypeAheadSuggestion: "type_ahead_Suggestion",
|
|
55
|
+
SemanticSuggestion: "semantic_Suggestion",
|
|
56
|
+
InstantAnswer: "instant_answer",
|
|
57
|
+
InstantAnswerReference: "instant_answer_reference",
|
|
58
|
+
};
|
|
38
59
|
export const AccessSource$zodSchema = z.enum([
|
|
39
60
|
"article_view",
|
|
40
61
|
"article_view_more_related_Article",
|
|
@@ -55,76 +76,24 @@ export const AccessSource$zodSchema = z.enum([
|
|
|
55
76
|
"semantic_Suggestion",
|
|
56
77
|
"instant_answer",
|
|
57
78
|
"instant_answer_reference",
|
|
58
|
-
]).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"
|
|
59
|
-
+ "\n"
|
|
60
|
-
+ "| Name | Description \n"
|
|
61
|
-
+ "| ---- | -----------\n"
|
|
62
|
-
+ "| article_view | View an Article directly using its ID.\n"
|
|
63
|
-
+ "| article_view_more_related_Article | View related articles of an Article using its ID.\n"
|
|
64
|
-
+ "| article_view_basic_search | View an Article via a basic search.\n"
|
|
65
|
-
+ "| article_view_adv_search | View an Article via an advanced search.\n"
|
|
66
|
-
+ "| article_view_guided_help | View an Article via a Guided Help solution.\n"
|
|
67
|
-
+ "| article_view_browse_topic | View an Article via browsing a topic.\n"
|
|
68
|
-
+ "| article_view_browse_tree | View an Article via browsing a topic tree.\n"
|
|
69
|
-
+ "| article_view_popular_articles | View an Article using the Popular Items list in the Self-Service portal.\n"
|
|
70
|
-
+ "| article_view_useful_items | View Article using the Useful Items list in the Self-Service portal.\n"
|
|
71
|
-
+ "| article_view_widget | View an Article via a widget.\n"
|
|
72
|
-
+ "| article_view_announcement | View an Article from the announcement section in the Self-Service portal.\n"
|
|
73
|
-
+ "| article_view_bookmarked | View a bookmarked Article.\n"
|
|
74
|
-
+ "| article_view_subscription_notification | View an Article from a subscription notification.\n"
|
|
75
|
-
+ "| article_view_guided_help_additional_info | View an Article via additional information from a Guided Help search.\n"
|
|
76
|
-
+ "| view_articles_pending_compliance | View an Article via Read & Sign in the Self-Service portal.\n"
|
|
77
|
-
+ "| type_ahead_Suggestion | View an Article from a type-ahead Suggestion in the Self-Service portal.\n"
|
|
78
|
-
+ "| semantic_Suggestion | View an Article from a semantic Suggestion in the Self-Service portal.\n"
|
|
79
|
-
+ "| instant_answer | View an Article via an Instant Answers solution.\n"
|
|
80
|
-
+ "| instant_answer_reference | View an Article that is used as a reference for an Instant Answers solution.\n"
|
|
81
|
-
+ "");
|
|
79
|
+
]).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");
|
|
82
80
|
export const GetArticleByIdRequest$zodSchema = z.object({
|
|
83
81
|
Dollar_customAdditionalAttributes: z.string().optional(),
|
|
84
|
-
Dollar_lang: LanguageQueryParameter$zodSchema.
|
|
82
|
+
Dollar_lang: LanguageQueryParameter$zodSchema.optional(),
|
|
85
83
|
acceptLanguage: AcceptLanguage$zodSchema.default("en-US"),
|
|
86
84
|
accessSource: AccessSource$zodSchema.default("article_view"),
|
|
87
85
|
articleAdditionalAttributes: z.array(ArticleAdditionalAttributes$zodSchema)
|
|
88
|
-
.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"
|
|
89
|
-
+ "\n"
|
|
90
|
-
+ "#### Default Attributes\n"
|
|
91
|
-
+ "These Article attributes are always returned:\n"
|
|
92
|
-
+ "\n"
|
|
93
|
-
+ "| Name | Description \n"
|
|
94
|
-
+ "| ---- | -----------\n"
|
|
95
|
-
+ "| id | The ID of the Article.\n"
|
|
96
|
-
+ "| name | The name of the Article.\n"
|
|
97
|
-
+ "| additionalInfo | Additional information provided as Article metadata.\n"
|
|
98
|
-
+ "| articleType | The Article type and its attributes.\n"
|
|
99
|
-
+ "| articleKeywords | A comma-separated list of keywords associated with this Article.\n"
|
|
100
|
-
+ "| articleState | The current state of the Article. States include A (Authoring), S (Staging), and P (Published).\n"
|
|
101
|
-
+ "| articleSummary | A brief summary of the Article, provided as metadata.\n"
|
|
102
|
-
+ "| createdBy | The ID, first name, middle name and last name of the user that created the Article.\n"
|
|
103
|
-
+ "| createdDate | The date that the Article was created.\n"
|
|
104
|
-
+ "| departmentId | ID of the department for which this Article belongs to.\n"
|
|
105
|
-
+ "| description | The Article's description.\n"
|
|
106
|
-
+ "| expirationDate | The date that the Article is set to expire.\n"
|
|
107
|
-
+ "| attachments | The Article's attachments\n"
|
|
108
|
-
+ "| imageURL | The URL of the image that is present in the Article version. It is used as the thumbnail image for the Article.\n"
|
|
109
|
-
+ "| includeInGenAI | Indicates whether this Article is used for eGain's generative AI features.\n"
|
|
110
|
-
+ "| isSubscribed | Indicates whether the Article is subscribed for notifications. \n"
|
|
111
|
-
+ "| languageCode | The language code of the Article language. \n"
|
|
112
|
-
+ "| link | The link object, used to retrieve the details of the Article.\n"
|
|
113
|
-
+ "| modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article.\n"
|
|
114
|
-
+ "| modifiedDate | The date that the Article was last modified on.\n"
|
|
115
|
-
+ "| topicBreadcrumb | Contains a list of topics from the top-level topic to this Article. There may be multiple paths.\n"
|
|
116
|
-
+ "| versionId | The ID of the Article version that is returned.\n"
|
|
117
|
-
+ "").optional(),
|
|
86
|
+
.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(),
|
|
118
87
|
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."),
|
|
119
88
|
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."),
|
|
120
89
|
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(),
|
|
121
90
|
workflowMilestone: WorkflowMilestone$zodSchema.optional(),
|
|
91
|
+
xEgainActivityId: z.string().describe("A unique numeric interaction identifier from eGain.").optional(),
|
|
92
|
+
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(),
|
|
93
|
+
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(),
|
|
122
94
|
});
|
|
123
|
-
export const GetArticleByIdResponse$zodSchema = z.
|
|
124
|
-
Article
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
StatusCode: z.number().int(),
|
|
128
|
-
WSErrorCommon: WSErrorCommon$zodSchema.optional(),
|
|
129
|
-
});
|
|
95
|
+
export const GetArticleByIdResponse$zodSchema = z.union([
|
|
96
|
+
Article$zodSchema,
|
|
97
|
+
WSErrorCommon$zodSchema,
|
|
98
|
+
]);
|
|
130
99
|
//# sourceMappingURL=getarticlebyidop.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getarticlebyidop.js","sourceRoot":"","sources":["../../../src/models/getarticlebyidop.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"getarticlebyidop.js","sourceRoot":"","sources":["../../../src/models/getarticlebyidop.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAAkB,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAW,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC1D,OAAO,EAEL,qCAAqC,GACtC,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAEL,gCAAgC,GACjC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAEL,2BAA2B,GAC5B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAiB,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,WAAW,EAAE,cAAc;IAC3B,6BAA6B,EAAE,mCAAmC;IAClE,sBAAsB,EAAE,2BAA2B;IACnD,oBAAoB,EAAE,yBAAyB;IAC/C,qBAAqB,EAAE,0BAA0B;IACjD,sBAAsB,EAAE,2BAA2B;IACnD,qBAAqB,EAAE,0BAA0B;IACjD,0BAA0B,EAAE,+BAA+B;IAC3D,sBAAsB,EAAE,2BAA2B;IACnD,iBAAiB,EAAE,qBAAqB;IACxC,uBAAuB,EAAE,2BAA2B;IACpD,qBAAqB,EAAE,yBAAyB;IAChD,mCAAmC,EAAE,wCAAwC;IAC7E,mCAAmC,EACjC,0CAA0C;IAC5C,6BAA6B,EAAE,kCAAkC;IACjE,mBAAmB,EAAE,uBAAuB;IAC5C,kBAAkB,EAAE,qBAAqB;IACzC,aAAa,EAAE,gBAAgB;IAC/B,sBAAsB,EAAE,0BAA0B;CAC1C,CAAC;AA8BX,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,IAAI,CAAC;IAC3C,cAAc;IACd,mCAAmC;IACnC,2BAA2B;IAC3B,yBAAyB;IACzB,0BAA0B;IAC1B,2BAA2B;IAC3B,0BAA0B;IAC1B,+BAA+B;IAC/B,2BAA2B;IAC3B,qBAAqB;IACrB,2BAA2B;IAC3B,yBAAyB;IACzB,wCAAwC;IACxC,0CAA0C;IAC1C,kCAAkC;IAClC,uBAAuB;IACvB,qBAAqB;IACrB,gBAAgB;IAChB,0BAA0B;CAC3B,CAAC,CAAC,QAAQ,CACT,uyDAAuyD,CACxyD,CAAC;AAiBF,MAAM,CAAC,MAAM,+BAA+B,GAC1C,CAAC,CAAC,MAAM,CAAC;IACP,iCAAiC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACxD,WAAW,EAAE,gCAAgC,CAAC,QAAQ,EAAE;IACxD,cAAc,EAAE,wBAAwB,CAAC,OAAO,CAAC,OAAO,CAAC;IACzD,YAAY,EAAE,sBAAsB,CAAC,OAAO,CAAC,cAAc,CAAC;IAC5D,2BAA2B,EAAE,CAAC,CAAC,KAAK,CAAC,qCAAqC,CAAC;SACxE,QAAQ,CACP,q8DAAq8D,CACt8D,CAAC,QAAQ,EAAE;IACd,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAC5B,oHAAoH,CACrH;IACD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAC3B,iIAAiI,CAClI;IACD,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAChC,8cAA8c,CAC/c,CAAC,QAAQ,EAAE;IACZ,iBAAiB,EAAE,2BAA2B,CAAC,QAAQ,EAAE;IACzD,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CACnC,qDAAqD,CACtD,CAAC,QAAQ,EAAE;IACZ,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CACpC,sOAAsO,CACvO,CAAC,QAAQ,EAAE;IACZ,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CACpC,+KAA+K,CAChL,CAAC,QAAQ,EAAE;CACb,CAAC,CAAC;AAIL,MAAM,CAAC,MAAM,gCAAgC,GAEzC,CAAC,CAAC,KAAK,CAAC;IACV,iBAAiB;IACjB,uBAAuB;CACxB,CAAC,CAAC"}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import * as z from "zod";
|
|
2
2
|
import { AnswersRequest } from "./answersrequest.js";
|
|
3
|
-
import { AnswersResponse } from "./answersresponse.js";
|
|
4
3
|
import { RequiredLanguageCode } from "./requiredlanguagecode.js";
|
|
5
4
|
export type GetBestAnswerRequest = {
|
|
6
5
|
q: string;
|
|
@@ -13,12 +12,5 @@ export type GetBestAnswerRequest = {
|
|
|
13
12
|
dollarFilterTopicIds?: Array<string> | undefined;
|
|
14
13
|
AnswersRequest?: AnswersRequest | undefined;
|
|
15
14
|
};
|
|
16
|
-
export declare const GetBestAnswerRequest$zodSchema: z.ZodType<GetBestAnswerRequest
|
|
17
|
-
export type GetBestAnswerResponse = {
|
|
18
|
-
ContentType: string;
|
|
19
|
-
StatusCode: number;
|
|
20
|
-
RawResponse: Response;
|
|
21
|
-
AnswersResponse?: AnswersResponse | undefined;
|
|
22
|
-
};
|
|
23
|
-
export declare const GetBestAnswerResponse$zodSchema: z.ZodType<GetBestAnswerResponse, z.ZodTypeDef, unknown>;
|
|
15
|
+
export declare const GetBestAnswerRequest$zodSchema: z.ZodType<GetBestAnswerRequest>;
|
|
24
16
|
//# sourceMappingURL=getbestanswerop.d.ts.map
|