@qlik/api 1.45.0 → 1.46.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/api-keys.d.ts +2 -2
- package/api-keys.js +2 -2
- package/apps.d.ts +2 -2
- package/apps.js +2 -2
- package/assistants.d.ts +2 -2
- package/assistants.js +2 -2
- package/audits.d.ts +2 -2
- package/audits.js +2 -2
- package/auth-types.d.ts +1 -1
- package/auth.d.ts +2 -2
- package/auth.js +2 -2
- package/automation-connections.d.ts +2 -2
- package/automation-connections.js +2 -2
- package/automations.d.ts +2 -2
- package/automations.js +2 -2
- package/automl-deployments.d.ts +2 -2
- package/automl-deployments.js +2 -2
- package/automl-predictions.d.ts +2 -2
- package/automl-predictions.js +2 -2
- package/brands.d.ts +2 -2
- package/brands.js +2 -2
- package/chunks/{api-keys-C-ZqA-wl.d.ts → api-keys-D0c8ujRu.d.ts} +3 -3
- package/chunks/{apps-k7oY1h_6.d.ts → apps-CdqN0t8i.d.ts} +3 -3
- package/chunks/{assistants-BsDbpzl4.d.ts → assistants-BW8V6f0F.d.ts} +36 -36
- package/chunks/{audits-5CBpwcdx.d.ts → audits-D0ad6UDR.d.ts} +3 -3
- package/chunks/{auth-DFOXWfqh.d.ts → auth-DKv6n_GN.d.ts} +1 -1
- package/chunks/{auth-Do2Z8IEt.js → auth-DnVBiC8q.js} +1 -1
- package/chunks/{auth-DH6Zx6GE.js → auth-PA8-Loxu.js} +1 -1
- package/chunks/{auth-functions-By9Ryr3H.js → auth-functions-B3j26XdM.js} +31 -1
- package/chunks/{auth-types-B1c_1Nca.d.ts → auth-types-ua5FEdjz.d.ts} +5 -0
- package/chunks/{automation-connections-DRQDgw7Q.d.ts → automation-connections-BJuPyGkj.d.ts} +3 -3
- package/chunks/{automations-C0rperoU.d.ts → automations-DDzikXsW.d.ts} +3 -3
- package/chunks/{automl-deployments-B-WuR_zE.d.ts → automl-deployments-RC6MYluL.d.ts} +3 -3
- package/chunks/{automl-predictions-CewW0eZn.d.ts → automl-predictions-BC_cxfIy.d.ts} +3 -3
- package/chunks/{brands-C4eALPrs.d.ts → brands-JtflEMN1.d.ts} +3 -3
- package/chunks/{collections-Djmd9gof.d.ts → collections-B17vc2zP.d.ts} +3 -3
- package/chunks/{conditions-BRDxUbgu.d.ts → conditions-JgsgLbSx.d.ts} +3 -3
- package/chunks/{consumption-UNw8R7jN.d.ts → consumption-BBGQgCsU.d.ts} +3 -3
- package/chunks/{csp-origins-_4HBSdgU.d.ts → csp-origins-C2z2ryaw.d.ts} +3 -3
- package/chunks/{csrf-token-CsvbqXyY.d.ts → csrf-token-Cwz241tT.d.ts} +3 -3
- package/chunks/{data-alerts-DSV3VOnW.d.ts → data-alerts-rxwsP4C7.d.ts} +3 -3
- package/chunks/{data-assets-C3U3T_lj.d.ts → data-assets-BRJ0MQgV.d.ts} +3 -3
- package/chunks/{data-connections-CYbObLbP.d.ts → data-connections-9H_4Pih5.d.ts} +3 -3
- package/chunks/{data-credentials-CgCjw_Cn.d.ts → data-credentials-AULREOtn.d.ts} +3 -3
- package/chunks/{data-files-DH19MfYE.d.ts → data-files-CDxGxSIx.d.ts} +3 -3
- package/chunks/{data-qualities-BogHQw4I.d.ts → data-qualities-B-v0Njga.d.ts} +3 -3
- package/chunks/{data-sets-B27GmshO.d.ts → data-sets-ChmF7dI4.d.ts} +3 -3
- package/chunks/{data-sources-3oHpGsDR.d.ts → data-sources-oBO7aHct.d.ts} +3 -3
- package/chunks/{data-stores-BjfzMp9W.d.ts → data-stores-C2RE1Aos.d.ts} +3 -3
- package/chunks/{dcaas-A7hfpAI5.d.ts → dcaas-D4iZGtLn.d.ts} +3 -3
- package/chunks/{di-projects-BmqI8HAl.d.ts → di-projects-BxX0b3lC.d.ts} +3 -3
- package/chunks/{direct-access-agents-CfUpbi73.d.ts → direct-access-agents-XxiAo3y9.d.ts} +3 -3
- package/chunks/{encryption-CjBmNQDZ.d.ts → encryption-1JNNXFB7.d.ts} +3 -3
- package/chunks/{extensions-D05y2FWk.d.ts → extensions-qbclNpnA.d.ts} +3 -3
- package/chunks/{glossaries-vYbykU3r.d.ts → glossaries-g1PPnHoM.d.ts} +17 -17
- package/chunks/{groups-BapgngJf.d.ts → groups-DrqKqkAv.d.ts} +3 -3
- package/chunks/{identity-providers-CAxsp9hP.d.ts → identity-providers-iRAccwIg.d.ts} +3 -3
- package/chunks/{interceptors-BF556LaK.d.ts → interceptors-DHkfs1ua.d.ts} +1 -1
- package/chunks/{invoke-fetch-hML-5n7w.js → invoke-fetch-BxHtZ6mc.js} +1 -1
- package/chunks/{invoke-fetch-DLQ5LN79.js → invoke-fetch-DUEcQxLv.js} +2 -2
- package/chunks/{items-CjVrNg57.d.ts → items-N3gAR5AS.d.ts} +3 -3
- package/chunks/{knowledgebases-BFiV7Fwh.d.ts → knowledgebases-B0tcNrg8.d.ts} +3 -3
- package/chunks/{licenses-yZKgQ2k6.d.ts → licenses-CrB0eiUU.d.ts} +3 -3
- package/chunks/{lineage-graphs-Bkc04N-t.d.ts → lineage-graphs-BL1kIsvQ.d.ts} +3 -3
- package/chunks/{ml-CPzq_j0K.d.ts → ml-CQQZV57e.d.ts} +3 -3
- package/chunks/{notes-C5HjmBeI.d.ts → notes-BWDOf71L.d.ts} +3 -3
- package/chunks/{notifications-DfP7aWPH.d.ts → notifications--FW8kp8T.d.ts} +3 -3
- package/chunks/{oauth-clients-BmMEDuET.d.ts → oauth-clients-BDI9_NJw.d.ts} +3 -3
- package/chunks/{oauth-tokens-Dimf19DE.d.ts → oauth-tokens-CqViLZD0.d.ts} +3 -3
- package/chunks/{public-runtime-modules-n0gcxl0_.js → public-runtime-modules-BWdSJoOb.js} +8 -5
- package/chunks/{qix-CbiHOu7Z.d.ts → qix-8oI6W8Iq.d.ts} +3 -3
- package/chunks/{qix-B_hHiSSK.js → qix-CkFE9Ji0.js} +1 -1
- package/chunks/{qix-Wsz3JE_a.js → qix-OogL83RB.js} +3 -3
- package/chunks/{qix-chunk-entrypoint-w25mSjTi.js → qix-chunk-entrypoint-BtxQC2m8.js} +1 -1
- package/chunks/{questions-CFN7BgWt.d.ts → questions-DAXXmfTM.d.ts} +3 -3
- package/chunks/{quotas-BUH2e2K_.d.ts → quotas-BV0q47cU.d.ts} +3 -3
- package/chunks/{reload-tasks-DN3X2-30.d.ts → reload-tasks-DORwZo4c.d.ts} +3 -3
- package/chunks/{reloads-CpY6F3Y0.d.ts → reloads-C7RAAgAu.d.ts} +3 -3
- package/chunks/{report-templates-D5KOFkRi.d.ts → report-templates-C3P0_-D3.d.ts} +3 -3
- package/chunks/{reports-CRwCogRL.d.ts → reports-C7saF89N.d.ts} +3 -3
- package/chunks/{roles-DCzyiLdU.d.ts → roles-DBdOYajz.d.ts} +3 -3
- package/chunks/{sharing-tasks-DsxFrADQ.d.ts → sharing-tasks-Dm9L1sMF.d.ts} +3 -3
- package/chunks/{spaces-B0cx23Nc.d.ts → spaces-CjF6Q30z.d.ts} +3 -3
- package/chunks/{tasks-DWfE5JM_.d.ts → tasks-CX1ohkzr.d.ts} +3 -3
- package/chunks/{temp-contents-CU94UTZU.d.ts → temp-contents-D-NhmvhI.d.ts} +3 -3
- package/chunks/{tenants-DvtbiwAP.d.ts → tenants-BbFJ4gEC.d.ts} +3 -3
- package/chunks/{themes-BPkyCLWS.d.ts → themes-DCHwpvan.d.ts} +3 -3
- package/chunks/{transports-DlRmSWLj.d.ts → transports-CQoT2abX.d.ts} +15 -15
- package/chunks/{ui-config-BqX-bPjf.d.ts → ui-config-8gkgFE8J.d.ts} +3 -3
- package/chunks/{users-CuQ0nboa.d.ts → users-D7kk0z77.d.ts} +3 -3
- package/chunks/{web-integrations-D54LCd0Z.d.ts → web-integrations-BMiMloLY.d.ts} +3 -3
- package/chunks/{web-notifications-sUlHGnmy.d.ts → web-notifications-CGGnIRRw.d.ts} +3 -3
- package/chunks/{webhooks-Dw0FIeFq.d.ts → webhooks-tylLbUkb.d.ts} +3 -3
- package/collections.d.ts +2 -2
- package/collections.js +2 -2
- package/conditions.d.ts +2 -2
- package/conditions.js +2 -2
- package/consumption.d.ts +2 -2
- package/consumption.js +2 -2
- package/csp-origins.d.ts +2 -2
- package/csp-origins.js +2 -2
- package/csrf-token.d.ts +2 -2
- package/csrf-token.js +2 -2
- package/data-alerts.d.ts +2 -2
- package/data-alerts.js +2 -2
- package/data-assets.d.ts +2 -2
- package/data-assets.js +2 -2
- package/data-connections.d.ts +2 -2
- package/data-connections.js +2 -2
- package/data-credentials.d.ts +2 -2
- package/data-credentials.js +2 -2
- package/data-files.d.ts +2 -2
- package/data-files.js +2 -2
- package/data-qualities.d.ts +2 -2
- package/data-qualities.js +2 -2
- package/data-sets.d.ts +2 -2
- package/data-sets.js +2 -2
- package/data-sources.d.ts +2 -2
- package/data-sources.js +2 -2
- package/data-stores.d.ts +2 -2
- package/data-stores.js +2 -2
- package/dcaas.d.ts +2 -2
- package/dcaas.js +2 -2
- package/di-projects.d.ts +2 -2
- package/di-projects.js +2 -2
- package/direct-access-agents.d.ts +2 -2
- package/direct-access-agents.js +2 -2
- package/encryption.d.ts +2 -2
- package/encryption.js +2 -2
- package/extensions.d.ts +2 -2
- package/extensions.js +2 -2
- package/global-types.d.ts +1 -1
- package/glossaries.d.ts +2 -2
- package/glossaries.js +9 -9
- package/groups.d.ts +2 -2
- package/groups.js +2 -2
- package/identity-providers.d.ts +2 -2
- package/identity-providers.js +2 -2
- package/index.d.ts +79 -79
- package/index.js +188 -185
- package/interceptors.d.ts +2 -2
- package/invoke-fetch-types.d.ts +1 -1
- package/items.d.ts +2 -2
- package/items.js +2 -2
- package/knowledgebases.d.ts +2 -2
- package/knowledgebases.js +2 -2
- package/licenses.d.ts +2 -2
- package/licenses.js +2 -2
- package/lineage-graphs.d.ts +2 -2
- package/lineage-graphs.js +2 -2
- package/ml.d.ts +2 -2
- package/ml.js +2 -2
- package/notes.d.ts +2 -2
- package/notes.js +2 -2
- package/notifications.d.ts +2 -2
- package/notifications.js +2 -2
- package/oauth-clients.d.ts +2 -2
- package/oauth-clients.js +2 -2
- package/oauth-tokens.d.ts +2 -2
- package/oauth-tokens.js +2 -2
- package/package.json +3 -3
- package/qix.d.ts +3 -3
- package/qix.js +2 -2
- package/questions.d.ts +2 -2
- package/questions.js +2 -2
- package/quotas.d.ts +2 -2
- package/quotas.js +2 -2
- package/reload-tasks.d.ts +2 -2
- package/reload-tasks.js +2 -2
- package/reloads.d.ts +2 -2
- package/reloads.js +2 -2
- package/report-templates.d.ts +2 -2
- package/report-templates.js +2 -2
- package/reports.d.ts +2 -2
- package/reports.js +2 -2
- package/roles.d.ts +2 -2
- package/roles.js +2 -2
- package/sharing-tasks.d.ts +2 -2
- package/sharing-tasks.js +2 -2
- package/spaces.d.ts +2 -2
- package/spaces.js +2 -2
- package/tasks.d.ts +2 -2
- package/tasks.js +2 -2
- package/temp-contents.d.ts +2 -2
- package/temp-contents.js +2 -2
- package/tenants.d.ts +2 -2
- package/tenants.js +2 -2
- package/themes.d.ts +2 -2
- package/themes.js +2 -2
- package/transports.d.ts +2 -2
- package/transports.js +8 -8
- package/ui-config.d.ts +2 -2
- package/ui-config.js +2 -2
- package/users.d.ts +2 -2
- package/users.js +2 -2
- package/web-integrations.d.ts +2 -2
- package/web-integrations.js +2 -2
- package/web-notifications.d.ts +2 -2
- package/web-notifications.js +2 -2
- package/webhooks.d.ts +2 -2
- package/webhooks.js +2 -2
- package/website/assets/navigation.js +1 -1
- package/website/assets/search.js +1 -1
- package/website/functions/assistants.getAssistantStarters.html +3 -3
- package/website/functions/assistants.getAssistantThreads.html +3 -3
- package/website/functions/assistants.getAssistants.html +3 -3
- package/website/functions/automations.getAutomations.html +3 -3
- package/website/functions/glossaries.changeGlossaryTermStatus.html +1 -1
- package/website/functions/glossaries.createGlossary.html +1 -1
- package/website/functions/glossaries.createGlossaryTermLink.html +1 -1
- package/website/functions/glossaries.importGlossary.html +2 -2
- package/website/functions/glossaries.patchGlossary.html +1 -1
- package/website/functions/glossaries.patchGlossaryCategory.html +1 -1
- package/website/functions/knowledgebases.getKnowledgebases.html +3 -3
- package/website/functions/transports.deleteEmailConfig.html +1 -1
- package/website/functions/transports.getEmailConfig.html +1 -1
- package/website/functions/transports.patchEmailConfig.html +1 -1
- package/website/functions/transports.sendTestEmail.html +1 -1
- package/website/functions/transports.validateEmailConfig.html +1 -1
- package/website/functions/transports.verifyEmailConfigConnection.html +1 -1
- package/website/interfaces/index.QlikAPI.html +60 -60
- package/website/interfaces/qix.GenericObject.html +1 -1
- package/website/modules/api-keys.html +1 -1
- package/website/modules/apps.html +1 -1
- package/website/modules/assistants.html +1 -1
- package/website/modules/audits.html +1 -1
- package/website/modules/automation-connections.html +1 -1
- package/website/modules/automations.html +1 -1
- package/website/modules/automl-deployments.html +1 -1
- package/website/modules/automl-predictions.html +1 -1
- package/website/modules/brands.html +1 -1
- package/website/modules/collections.html +1 -1
- package/website/modules/conditions.html +1 -1
- package/website/modules/consumption.html +1 -1
- package/website/modules/csp-origins.html +1 -1
- package/website/modules/csrf-token.html +1 -1
- package/website/modules/data-alerts.html +1 -1
- package/website/modules/data-assets.html +1 -1
- package/website/modules/data-connections.html +1 -1
- package/website/modules/data-credentials.html +1 -1
- package/website/modules/data-files.html +1 -1
- package/website/modules/data-qualities.html +1 -1
- package/website/modules/data-sets.html +1 -1
- package/website/modules/data-sources.html +1 -1
- package/website/modules/data-stores.html +1 -1
- package/website/modules/dcaas.html +1 -1
- package/website/modules/di-projects.html +1 -1
- package/website/modules/direct-access-agents.html +1 -1
- package/website/modules/encryption.html +1 -1
- package/website/modules/extensions.html +1 -1
- package/website/modules/glossaries.html +1 -1
- package/website/modules/groups.html +1 -1
- package/website/modules/identity-providers.html +1 -1
- package/website/modules/items.html +1 -1
- package/website/modules/knowledgebases.html +1 -1
- package/website/modules/licenses.html +1 -1
- package/website/modules/lineage-graphs.html +1 -1
- package/website/modules/ml.html +1 -1
- package/website/modules/notes.html +1 -1
- package/website/modules/notifications.html +1 -1
- package/website/modules/oauth-clients.html +1 -1
- package/website/modules/oauth-tokens.html +1 -1
- package/website/modules/questions.html +1 -1
- package/website/modules/quotas.html +1 -1
- package/website/modules/reload-tasks.html +1 -1
- package/website/modules/reloads.html +1 -1
- package/website/modules/report-templates.html +1 -1
- package/website/modules/reports.html +1 -1
- package/website/modules/roles.html +1 -1
- package/website/modules/sharing-tasks.html +1 -1
- package/website/modules/spaces.html +1 -1
- package/website/modules/tasks.html +1 -1
- package/website/modules/temp-contents.html +1 -1
- package/website/modules/tenants.html +1 -1
- package/website/modules/themes.html +1 -1
- package/website/modules/transports.html +1 -1
- package/website/modules/ui-config.html +1 -1
- package/website/modules/users.html +1 -1
- package/website/modules/web-integrations.html +1 -1
- package/website/modules/web-notifications.html +1 -1
- package/website/modules/webhooks.html +1 -1
- package/website/types/api-keys.ApiKeysAPI.html +34 -0
- package/website/types/apps.AppsAPI.html +241 -0
- package/website/types/assistants.AssistantsAPI.html +156 -0
- package/website/types/assistants.CreateAssistantHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantStarterHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadInteractionFeedbackHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadInteractionHttpError.html +2 -2
- package/website/types/assistants.CreateAssistantThreadInteractionReviewHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantStarterFollowupHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantStarterHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.DeleteAssistantThreadInteractionHttpError.html +2 -2
- package/website/types/assistants.ErrorResponseCode.html +1 -11
- package/website/types/assistants.ErrorResponseCodeCopy.html +11 -1
- package/website/types/assistants.GetAssistantFeedbackHttpError.html +2 -2
- package/website/types/assistants.GetAssistantHttpError.html +2 -2
- package/website/types/assistants.GetAssistantSourcesHttpError.html +2 -2
- package/website/types/assistants.GetAssistantStarterHttpError.html +2 -2
- package/website/types/assistants.GetAssistantStartersHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadInteractionHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadInteractionsHttpError.html +2 -2
- package/website/types/assistants.GetAssistantThreadsHttpError.html +2 -2
- package/website/types/assistants.GetAssistantsHttpError.html +2 -2
- package/website/types/assistants.InvokeAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.PatchAssistantHttpError.html +2 -2
- package/website/types/assistants.PatchAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.PatchAssistantThreadInteractionFeedbackHttpError.html +2 -2
- package/website/types/assistants.StreamAssistantThreadHttpError.html +2 -2
- package/website/types/assistants.UpdateAssistantStarterFollowupHttpError.html +2 -2
- package/website/types/assistants.UpdateAssistantStarterHttpError.html +2 -2
- package/website/types/audits.AuditsAPI.html +27 -0
- package/website/types/automation-connections.AutomationConnectionsAPI.html +39 -0
- package/website/types/automations.AutomationsAPI.html +100 -0
- package/website/types/automl-deployments.AutomlDeploymentsAPI.html +9 -0
- package/website/types/automl-predictions.AutomlPredictionsAPI.html +32 -0
- package/website/types/brands.BrandsAPI.html +59 -0
- package/website/types/collections.CollectionsAPI.html +53 -0
- package/website/types/conditions.ConditionsAPI.html +50 -0
- package/website/types/consumption.ConsumptionAPI.html +7 -0
- package/website/types/csp-origins.CspOriginsAPI.html +27 -0
- package/website/{interfaces → types}/csrf-token.CsrfTokenAPI.html +4 -7
- package/website/types/data-alerts.DataAlertsAPI.html +73 -0
- package/website/types/data-assets.DataAssetsAPI.html +23 -0
- package/website/types/data-connections.DataConnectionsAPI.html +54 -0
- package/website/types/data-credentials.DataCredentialsAPI.html +35 -0
- package/website/types/data-files.DataFilesAPI.html +86 -0
- package/website/types/data-qualities.DataQualitiesAPI.html +18 -0
- package/website/types/data-sets.DataSetsAPI.html +27 -0
- package/website/types/data-sources.DataSourcesAPI.html +25 -0
- package/website/types/data-stores.DataStoresAPI.html +47 -0
- package/website/types/dcaas.DcaasAPI.html +15 -0
- package/website/types/di-projects.DiProjectsAPI.html +104 -0
- package/website/types/direct-access-agents.DirectAccessAgentsAPI.html +72 -0
- package/website/types/encryption.EncryptionAPI.html +40 -0
- package/website/types/extensions.ExtensionsAPI.html +32 -0
- package/website/types/glossaries.GlossariesAPI.html +127 -0
- package/website/types/groups.GroupsAPI.html +36 -0
- package/website/types/identity-providers.IdentityProvidersAPI.html +33 -0
- package/website/types/items.ItemsAPI.html +37 -0
- package/website/types/knowledgebases.KnowledgebasesAPI.html +90 -0
- package/website/types/licenses.LicensesAPI.html +36 -0
- package/website/types/lineage-graphs.LineageGraphsAPI.html +60 -0
- package/website/types/ml.MlAPI.html +230 -0
- package/website/{interfaces → types}/notes.NotesAPI.html +7 -13
- package/website/{interfaces → types}/notifications.NotificationsAPI.html +5 -12
- package/website/types/oauth-clients.OauthClientsAPI.html +53 -0
- package/website/types/oauth-tokens.OauthTokensAPI.html +11 -0
- package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
- package/website/types/qix.RpcObject.html +1 -1
- package/website/types/qix.VariableListItem.html +1 -1
- package/website/types/questions.QuestionsAPI.html +12 -0
- package/website/types/quotas.QuotasAPI.html +12 -0
- package/website/types/reload-tasks.ReloadTasksAPI.html +24 -0
- package/website/types/reloads.ReloadsAPI.html +22 -0
- package/website/types/report-templates.ReportTemplatesAPI.html +33 -0
- package/website/types/reports.ReportsAPI.html +17 -0
- package/website/types/roles.RolesAPI.html +24 -0
- package/website/types/sharing-tasks.SharingTasksAPI.html +62 -0
- package/website/types/spaces.SpacesAPI.html +84 -0
- package/website/types/tasks.TasksAPI.html +49 -0
- package/website/types/temp-contents.TempContentsAPI.html +17 -0
- package/website/types/tenants.TenantsAPI.html +29 -0
- package/website/types/themes.ThemesAPI.html +32 -0
- package/website/types/transports.TransportsAPI.html +23 -0
- package/website/types/ui-config.UiConfigAPI.html +30 -0
- package/website/types/users.UsersAPI.html +41 -0
- package/website/types/web-integrations.WebIntegrationsAPI.html +24 -0
- package/website/types/web-notifications.WebNotificationsAPI.html +30 -0
- package/website/types/webhooks.WebhooksAPI.html +47 -0
- package/website/variables/index.apiKeys.html +1 -1
- package/website/variables/index.apps.html +1 -1
- package/website/variables/index.assistants.html +1 -1
- package/website/variables/index.audits.html +1 -1
- package/website/variables/index.automationConnections.html +1 -1
- package/website/variables/index.automations.html +1 -1
- package/website/variables/index.automlDeployments.html +1 -1
- package/website/variables/index.automlPredictions.html +1 -1
- package/website/variables/index.brands.html +1 -1
- package/website/variables/index.collections.html +1 -1
- package/website/variables/index.conditions.html +1 -1
- package/website/variables/index.consumption.html +1 -1
- package/website/variables/index.cspOrigins.html +1 -1
- package/website/variables/index.csrfToken.html +1 -1
- package/website/variables/index.dataAlerts.html +1 -1
- package/website/variables/index.dataAssets.html +1 -1
- package/website/variables/index.dataConnections.html +1 -1
- package/website/variables/index.dataCredentials.html +1 -1
- package/website/variables/index.dataFiles.html +1 -1
- package/website/variables/index.dataQualities.html +1 -1
- package/website/variables/index.dataSets.html +1 -1
- package/website/variables/index.dataSources.html +1 -1
- package/website/variables/index.dataStores.html +1 -1
- package/website/variables/index.dcaas.html +1 -1
- package/website/variables/index.diProjects.html +1 -1
- package/website/variables/index.directAccessAgents.html +1 -1
- package/website/variables/index.encryption.html +1 -1
- package/website/variables/index.extensions.html +1 -1
- package/website/variables/index.glossaries.html +1 -1
- package/website/variables/index.groups.html +1 -1
- package/website/variables/index.identityProviders.html +1 -1
- package/website/variables/index.items.html +1 -1
- package/website/variables/index.knowledgebases.html +1 -1
- package/website/variables/index.licenses.html +1 -1
- package/website/variables/index.lineageGraphs.html +1 -1
- package/website/variables/index.ml.html +1 -1
- package/website/variables/index.notes.html +1 -1
- package/website/variables/index.notifications.html +1 -1
- package/website/variables/index.oauthClients.html +1 -1
- package/website/variables/index.oauthTokens.html +1 -1
- package/website/variables/index.questions.html +1 -1
- package/website/variables/index.quotas.html +1 -1
- package/website/variables/index.reloadTasks.html +1 -1
- package/website/variables/index.reloads.html +1 -1
- package/website/variables/index.reportTemplates.html +1 -1
- package/website/variables/index.reports.html +1 -1
- package/website/variables/index.roles.html +1 -1
- package/website/variables/index.sharingTasks.html +1 -1
- package/website/variables/index.spaces.html +1 -1
- package/website/variables/index.tasks.html +1 -1
- package/website/variables/index.tempContents.html +1 -1
- package/website/variables/index.tenants.html +1 -1
- package/website/variables/index.themes.html +1 -1
- package/website/variables/index.transports.html +1 -1
- package/website/variables/index.uiConfig.html +1 -1
- package/website/variables/index.users.html +1 -1
- package/website/variables/index.webIntegrations.html +1 -1
- package/website/variables/index.webNotifications.html +1 -1
- package/website/variables/index.webhooks.html +1 -1
- package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
- package/website/interfaces/api-keys.ApiKeysAPI.html +0 -66
- package/website/interfaces/apps.AppsAPI.html +0 -486
- package/website/interfaces/assistants.AssistantsAPI.html +0 -300
- package/website/interfaces/audits.AuditsAPI.html +0 -55
- package/website/interfaces/automation-connections.AutomationConnectionsAPI.html +0 -73
- package/website/interfaces/automations.AutomationsAPI.html +0 -199
- package/website/interfaces/automl-deployments.AutomlDeploymentsAPI.html +0 -19
- package/website/interfaces/automl-predictions.AutomlPredictionsAPI.html +0 -56
- package/website/interfaces/brands.BrandsAPI.html +0 -115
- package/website/interfaces/collections.CollectionsAPI.html +0 -119
- package/website/interfaces/conditions.ConditionsAPI.html +0 -87
- package/website/interfaces/consumption.ConsumptionAPI.html +0 -20
- package/website/interfaces/csp-origins.CspOriginsAPI.html +0 -65
- package/website/interfaces/data-alerts.DataAlertsAPI.html +0 -162
- package/website/interfaces/data-assets.DataAssetsAPI.html +0 -40
- package/website/interfaces/data-connections.DataConnectionsAPI.html +0 -125
- package/website/interfaces/data-credentials.DataCredentialsAPI.html +0 -67
- package/website/interfaces/data-files.DataFilesAPI.html +0 -268
- package/website/interfaces/data-qualities.DataQualitiesAPI.html +0 -33
- package/website/interfaces/data-sets.DataSetsAPI.html +0 -50
- package/website/interfaces/data-sources.DataSourcesAPI.html +0 -50
- package/website/interfaces/data-stores.DataStoresAPI.html +0 -92
- package/website/interfaces/dcaas.DcaasAPI.html +0 -26
- package/website/interfaces/di-projects.DiProjectsAPI.html +0 -192
- package/website/interfaces/direct-access-agents.DirectAccessAgentsAPI.html +0 -131
- package/website/interfaces/encryption.EncryptionAPI.html +0 -68
- package/website/interfaces/extensions.ExtensionsAPI.html +0 -59
- package/website/interfaces/glossaries.GlossariesAPI.html +0 -271
- package/website/interfaces/groups.GroupsAPI.html +0 -73
- package/website/interfaces/identity-providers.IdentityProvidersAPI.html +0 -60
- package/website/interfaces/items.ItemsAPI.html +0 -97
- package/website/interfaces/knowledgebases.KnowledgebasesAPI.html +0 -175
- package/website/interfaces/licenses.LicensesAPI.html +0 -70
- package/website/interfaces/lineage-graphs.LineageGraphsAPI.html +0 -133
- package/website/interfaces/ml.MlAPI.html +0 -552
- package/website/interfaces/oauth-clients.OauthClientsAPI.html +0 -99
- package/website/interfaces/oauth-tokens.OauthTokensAPI.html +0 -22
- package/website/interfaces/questions.QuestionsAPI.html +0 -23
- package/website/interfaces/quotas.QuotasAPI.html +0 -22
- package/website/interfaces/reload-tasks.ReloadTasksAPI.html +0 -46
- package/website/interfaces/reloads.ReloadsAPI.html +0 -56
- package/website/interfaces/report-templates.ReportTemplatesAPI.html +0 -63
- package/website/interfaces/reports.ReportsAPI.html +0 -36
- package/website/interfaces/roles.RolesAPI.html +0 -47
- package/website/interfaces/sharing-tasks.SharingTasksAPI.html +0 -131
- package/website/interfaces/spaces.SpacesAPI.html +0 -171
- package/website/interfaces/tasks.TasksAPI.html +0 -102
- package/website/interfaces/temp-contents.TempContentsAPI.html +0 -33
- package/website/interfaces/tenants.TenantsAPI.html +0 -50
- package/website/interfaces/themes.ThemesAPI.html +0 -59
- package/website/interfaces/transports.TransportsAPI.html +0 -38
- package/website/interfaces/ui-config.UiConfigAPI.html +0 -51
- package/website/interfaces/users.UsersAPI.html +0 -112
- package/website/interfaces/web-integrations.WebIntegrationsAPI.html +0 -46
- package/website/interfaces/web-notifications.WebNotificationsAPI.html +0 -57
- package/website/interfaces/webhooks.WebhooksAPI.html +0 -101
|
@@ -1,175 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>KnowledgebasesAPI | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/knowledgebases.html">knowledgebases</a></li><li><a href="" aria-current="page">KnowledgebasesAPI</a></li></ul><h1>Interface KnowledgebasesAPI</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">KnowledgebasesAPI</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#cancelknowledgebasedatasource">cancelKnowledgebaseDatasource</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CancelKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CancelKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#clearcache">clearCache</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#createknowledgebase">createKnowledgebase</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.CreateKnowledgeBase.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgeBase</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#createknowledgebasedatasource">createKnowledgebaseDatasource</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.CreateDataSource.html" class="tsd-signature-type tsd-kind-type-alias">CreateDataSource</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#createknowledgebasedatasourceschedule">createKnowledgebaseDatasourceSchedule</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.Schedule.html" class="tsd-signature-type tsd-kind-type-alias">Schedule</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#deleteknowledgebase">deleteKnowledgebase</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#deleteknowledgebasedatasource">deleteKnowledgebaseDatasource</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#deleteknowledgebasedatasourceschedule">deleteKnowledgebaseDatasourceSchedule</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#downloadknowledgebasedatasource">downloadKnowledgebaseDatasource</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.DownloadFile.html" class="tsd-signature-type tsd-kind-type-alias">DownloadFile</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DownloadKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DownloadKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getknowledgebase">getKnowledgebase</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getknowledgebasedatasourcehistories">getKnowledgebaseDatasourceHistories</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"COMPLETED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-COMPLETED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceHistoriesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceHistoriesHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getknowledgebasedatasourcehistory">getKnowledgebaseDatasourceHistory</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">syncId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceHistoryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceHistoryHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getknowledgebasedatasourceschedule">getKnowledgebaseDatasourceSchedule</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getknowledgebasehistories">getKnowledgebaseHistories</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"COMPLETED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-COMPLETED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseHistoriesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseHistoriesHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#getknowledgebases">getKnowledgebases</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">countTotal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebasesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebasesHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#patchknowledgebase">patchKnowledgebase</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.JSONPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchArray</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.PatchKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#syncknowledgebasedatasource">syncKnowledgebaseDatasource</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">migrate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.SyncKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">SyncKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updateknowledgebasedatasource">updateKnowledgebaseDatasource</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.DataSource.html" class="tsd-signature-type tsd-kind-type-alias">DataSource</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.UpdateKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#cancelknowledgebasedatasource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cancel<wbr/>Knowledgebase<wbr/>Datasource</span></a>
|
|
2
|
-
<a href="#clearcache" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear<wbr/>Cache</span></a>
|
|
3
|
-
<a href="#createknowledgebase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Knowledgebase</span></a>
|
|
4
|
-
<a href="#createknowledgebasedatasource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Knowledgebase<wbr/>Datasource</span></a>
|
|
5
|
-
<a href="#createknowledgebasedatasourceschedule" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Schedule</span></a>
|
|
6
|
-
<a href="#deleteknowledgebase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Knowledgebase</span></a>
|
|
7
|
-
<a href="#deleteknowledgebasedatasource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Knowledgebase<wbr/>Datasource</span></a>
|
|
8
|
-
<a href="#deleteknowledgebasedatasourceschedule" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Schedule</span></a>
|
|
9
|
-
<a href="#downloadknowledgebasedatasource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>download<wbr/>Knowledgebase<wbr/>Datasource</span></a>
|
|
10
|
-
<a href="#getknowledgebase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebase</span></a>
|
|
11
|
-
<a href="#getknowledgebasedatasourcehistories" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Histories</span></a>
|
|
12
|
-
<a href="#getknowledgebasedatasourcehistory" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebase<wbr/>Datasource<wbr/>History</span></a>
|
|
13
|
-
<a href="#getknowledgebasedatasourceschedule" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Schedule</span></a>
|
|
14
|
-
<a href="#getknowledgebasehistories" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebase<wbr/>Histories</span></a>
|
|
15
|
-
<a href="#getknowledgebases" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebases</span></a>
|
|
16
|
-
<a href="#patchknowledgebase" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Knowledgebase</span></a>
|
|
17
|
-
<a href="#syncknowledgebasedatasource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sync<wbr/>Knowledgebase<wbr/>Datasource</span></a>
|
|
18
|
-
<a href="#updateknowledgebasedatasource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Knowledgebase<wbr/>Datasource</span></a>
|
|
19
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="cancelknowledgebasedatasource"><span>cancel<wbr/>Knowledgebase<wbr/>Datasource</span><a href="#cancelknowledgebasedatasource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cancelKnowledgebaseDatasource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CancelKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CancelKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Cancels ongoing sync for a specified datasource.</p>
|
|
20
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CancelKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CancelKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Cancels ongoing sync for a specified datasource.</p>
|
|
21
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
22
|
-
</div></li><li><span><span class="tsd-kind-parameter">datasourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the datasource to cancel sync for.</p>
|
|
23
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CancelKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CancelKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CancelKnowledgebaseDatasourceHttpError</p>
|
|
24
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id">Param: id<a href="#param-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
25
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid">Param: datasourceId<a href="#param-datasourceid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the datasource to cancel sync for.</p>
|
|
26
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CancelKnowledgebaseDatasourceHttpError</p>
|
|
27
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearcache"><span>clear<wbr/>Cache</span><a href="#clearcache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clearCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears the cache for knowledgebases api requests.</p>
|
|
28
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the cache for knowledgebases api requests.</p>
|
|
29
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createknowledgebase"><span>create<wbr/>Knowledgebase</span><a href="#createknowledgebase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createKnowledgebase</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.CreateKnowledgeBase.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgeBase</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates a new knowledgebase.</p>
|
|
30
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.CreateKnowledgeBase.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgeBase</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new knowledgebase.</p>
|
|
31
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/knowledgebases.CreateKnowledgeBase.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgeBase</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
32
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateKnowledgebaseHttpError</p>
|
|
33
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body">Param: body<a href="#param-body" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
34
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateKnowledgebaseHttpError</p>
|
|
35
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createknowledgebasedatasource"><span>create<wbr/>Knowledgebase<wbr/>Datasource</span><a href="#createknowledgebasedatasource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createKnowledgebaseDatasource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.CreateDataSource.html" class="tsd-signature-type tsd-kind-type-alias">CreateDataSource</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Adds a datasource to a knowledgebase.</p>
|
|
36
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.CreateDataSource.html" class="tsd-signature-type tsd-kind-type-alias">CreateDataSource</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a datasource to a knowledgebase.</p>
|
|
37
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase.</p>
|
|
38
|
-
</div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/knowledgebases.CreateDataSource.html" class="tsd-signature-type tsd-kind-type-alias">CreateDataSource</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
39
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateKnowledgebaseDatasourceHttpError</p>
|
|
40
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-1">Param: id<a href="#param-id-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase.</p>
|
|
41
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-1">Param: body<a href="#param-body-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
42
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-5">Throws<a href="#throws-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateKnowledgebaseDatasourceHttpError</p>
|
|
43
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createknowledgebasedatasourceschedule"><span>create<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Schedule</span><a href="#createknowledgebasedatasourceschedule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createKnowledgebaseDatasourceSchedule</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.Schedule.html" class="tsd-signature-type tsd-kind-type-alias">Schedule</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates or updates a specified datasource schedule.</p>
|
|
44
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.Schedule.html" class="tsd-signature-type tsd-kind-type-alias">Schedule</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates or updates a specified datasource schedule.</p>
|
|
45
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase the schedule belongs to.</p>
|
|
46
|
-
</div></li><li><span><span class="tsd-kind-parameter">datasourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the datasource the schedule belongs to.</p>
|
|
47
|
-
</div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/knowledgebases.Schedule.html" class="tsd-signature-type tsd-kind-type-alias">Schedule</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
48
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.CreateKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-6">Throws<a href="#throws-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateKnowledgebaseDatasourceScheduleHttpError</p>
|
|
49
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-2">Param: id<a href="#param-id-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase the schedule belongs to.</p>
|
|
50
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid-1">Param: datasourceId<a href="#param-datasourceid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the datasource the schedule belongs to.</p>
|
|
51
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-2">Param: body<a href="#param-body-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
52
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-7">Throws<a href="#throws-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateKnowledgebaseDatasourceScheduleHttpError</p>
|
|
53
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteknowledgebase"><span>delete<wbr/>Knowledgebase</span><a href="#deleteknowledgebase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteKnowledgebase</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes a knowledgebase and all of its resources.</p>
|
|
54
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes a knowledgebase and all of its resources.</p>
|
|
55
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase to delete.</p>
|
|
56
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-8">Throws<a href="#throws-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteKnowledgebaseHttpError</p>
|
|
57
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-3">Param: id<a href="#param-id-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase to delete.</p>
|
|
58
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-9">Throws<a href="#throws-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteKnowledgebaseHttpError</p>
|
|
59
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteknowledgebasedatasource"><span>delete<wbr/>Knowledgebase<wbr/>Datasource</span><a href="#deleteknowledgebasedatasource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteKnowledgebaseDatasource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes a specified datasource and all its resources.</p>
|
|
60
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes a specified datasource and all its resources.</p>
|
|
61
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
62
|
-
</div></li><li><span><span class="tsd-kind-parameter">datasourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the datasource to delete.</p>
|
|
63
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-10">Throws<a href="#throws-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteKnowledgebaseDatasourceHttpError</p>
|
|
64
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-4">Param: id<a href="#param-id-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
65
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid-2">Param: datasourceId<a href="#param-datasourceid-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the datasource to delete.</p>
|
|
66
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-11">Throws<a href="#throws-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteKnowledgebaseDatasourceHttpError</p>
|
|
67
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteknowledgebasedatasourceschedule"><span>delete<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Schedule</span><a href="#deleteknowledgebasedatasourceschedule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteKnowledgebaseDatasourceSchedule</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Delete knowledgebase datasource schedule</p>
|
|
68
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete knowledgebase datasource schedule</p>
|
|
69
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase the schedule belongs to.</p>
|
|
70
|
-
</div></li><li><span><span class="tsd-kind-parameter">datasourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the datasource the schedule belongs to.</p>
|
|
71
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DeleteKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-12">Throws<a href="#throws-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteKnowledgebaseDatasourceScheduleHttpError</p>
|
|
72
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-5">Param: id<a href="#param-id-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase the schedule belongs to.</p>
|
|
73
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid-3">Param: datasourceId<a href="#param-datasourceid-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the datasource the schedule belongs to.</p>
|
|
74
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-13">Throws<a href="#throws-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteKnowledgebaseDatasourceScheduleHttpError</p>
|
|
75
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="downloadknowledgebasedatasource"><span>download<wbr/>Knowledgebase<wbr/>Datasource</span><a href="#downloadknowledgebasedatasource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">downloadKnowledgebaseDatasource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.DownloadFile.html" class="tsd-signature-type tsd-kind-type-alias">DownloadFile</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DownloadKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DownloadKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Download knowledgebase datasource reference</p>
|
|
76
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.DownloadFile.html" class="tsd-signature-type tsd-kind-type-alias">DownloadFile</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DownloadKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DownloadKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Download knowledgebase datasource reference</p>
|
|
77
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
78
|
-
</div></li><li><span><span class="tsd-kind-parameter">datasourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the datasource to download from.</p>
|
|
79
|
-
</div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/knowledgebases.DownloadFile.html" class="tsd-signature-type tsd-kind-type-alias">DownloadFile</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
80
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.DownloadKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DownloadKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-14">Throws<a href="#throws-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DownloadKnowledgebaseDatasourceHttpError</p>
|
|
81
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-6">Param: id<a href="#param-id-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
82
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid-4">Param: datasourceId<a href="#param-datasourceid-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the datasource to download from.</p>
|
|
83
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-3">Param: body<a href="#param-body-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
84
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-15">Throws<a href="#throws-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DownloadKnowledgebaseDatasourceHttpError</p>
|
|
85
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getknowledgebase"><span>get<wbr/>Knowledgebase</span><a href="#getknowledgebase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getKnowledgebase</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves a specific knowledgebase.</p>
|
|
86
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a specific knowledgebase.</p>
|
|
87
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase to retrieve.</p>
|
|
88
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-16">Throws<a href="#throws-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebaseHttpError</p>
|
|
89
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-7">Param: id<a href="#param-id-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase to retrieve.</p>
|
|
90
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-17">Throws<a href="#throws-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebaseHttpError</p>
|
|
91
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getknowledgebasedatasourcehistories"><span>get<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Histories</span><a href="#getknowledgebasedatasourcehistories" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getKnowledgebaseDatasourceHistories</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"COMPLETED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-COMPLETED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceHistoriesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceHistoriesHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves sync history for a specified datasource in a knowledgebase. Returns a <code>404</code> if there is no sync history, or if the calling user doesn't have access to the datasource.</p>
|
|
92
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"COMPLETED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-COMPLETED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceHistoriesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceHistoriesHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves sync history for a specified datasource in a knowledgebase. Returns a <code>404</code> if there is no sync history, or if the calling user doesn't have access to the datasource.</p>
|
|
93
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
94
|
-
</div></li><li><span><span class="tsd-kind-parameter">datasourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the datasource.</p>
|
|
95
|
-
</div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"COMPLETED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-COMPLETED"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
96
|
-
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The number of knowledgebases to get.</p>
|
|
97
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Optional parameter to request the next page.</p>
|
|
98
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Optional parameter to request the previous page.</p>
|
|
99
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"COMPLETED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-COMPLETED"</span></h5><div class="tsd-comment tsd-typography"><p>Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending.</p>
|
|
100
|
-
</div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceHistoriesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceHistoriesHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-18">Throws<a href="#throws-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebaseDatasourceHistoriesHttpError</p>
|
|
101
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-8">Param: id<a href="#param-id-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
102
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid-5">Param: datasourceId<a href="#param-datasourceid-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the datasource.</p>
|
|
103
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query">Param: query<a href="#param-query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
|
|
104
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-19">Throws<a href="#throws-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebaseDatasourceHistoriesHttpError</p>
|
|
105
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getknowledgebasedatasourcehistory"><span class="deprecated">get<wbr/>Knowledgebase<wbr/>Datasource<wbr/>History</span><a href="#getknowledgebasedatasourcehistory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getKnowledgebaseDatasourceHistory</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">syncId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceHistoryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceHistoryHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">syncId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceHistoryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceHistoryHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
106
|
-
</div></li><li><span><span class="tsd-kind-parameter">datasourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the datasource.</p>
|
|
107
|
-
</div></li><li><span><span class="tsd-kind-parameter">syncId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The sync identifier.</p>
|
|
108
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceHistoryHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceHistoryHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Retrieves detailed sync history for a specified datasource.</p>
|
|
109
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-20">Throws<a href="#throws-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebaseDatasourceHistoryHttpError</p>
|
|
110
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Retrieves detailed sync history for a specified datasource.</p>
|
|
111
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-9">Param: id<a href="#param-id-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
112
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid-6">Param: datasourceId<a href="#param-datasourceid-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the datasource.</p>
|
|
113
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-syncid">Param: syncId<a href="#param-syncid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The sync identifier.</p>
|
|
114
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-21">Throws<a href="#throws-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebaseDatasourceHistoryHttpError</p>
|
|
115
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getknowledgebasedatasourceschedule"><span>get<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Schedule</span><a href="#getknowledgebasedatasourceschedule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getKnowledgebaseDatasourceSchedule</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Get a knowledgebase datasource schedule</p>
|
|
116
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a knowledgebase datasource schedule</p>
|
|
117
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase the schedule belongs to.</p>
|
|
118
|
-
</div></li><li><span><span class="tsd-kind-parameter">datasourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the datasource the schedule belongs to.</p>
|
|
119
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseDatasourceScheduleHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseDatasourceScheduleHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-22">Throws<a href="#throws-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebaseDatasourceScheduleHttpError</p>
|
|
120
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-10">Param: id<a href="#param-id-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase the schedule belongs to.</p>
|
|
121
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid-7">Param: datasourceId<a href="#param-datasourceid-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the datasource the schedule belongs to.</p>
|
|
122
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-23">Throws<a href="#throws-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebaseDatasourceScheduleHttpError</p>
|
|
123
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getknowledgebasehistories"><span>get<wbr/>Knowledgebase<wbr/>Histories</span><a href="#getknowledgebasehistories" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getKnowledgebaseHistories</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"COMPLETED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-COMPLETED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseHistoriesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseHistoriesHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves sync history for the specified knowledgebase. Will return a <code>404</code> if no sync history exists, or if the calling user does not have access to synced datasources.</p>
|
|
124
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"COMPLETED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-COMPLETED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseHistoriesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseHistoriesHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves sync history for the specified knowledgebase. Will return a <code>404</code> if no sync history exists, or if the calling user does not have access to synced datasources.</p>
|
|
125
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase.</p>
|
|
126
|
-
</div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"COMPLETED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-COMPLETED"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
127
|
-
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The number of sync histories to get.</p>
|
|
128
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Optional parameter to request the next page.</p>
|
|
129
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Optional parameter to request the previous page.</p>
|
|
130
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"COMPLETED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-COMPLETED"</span></h5><div class="tsd-comment tsd-typography"><p>Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending.</p>
|
|
131
|
-
</div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebaseHistoriesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebaseHistoriesHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-24">Throws<a href="#throws-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebaseHistoriesHttpError</p>
|
|
132
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-11">Param: id<a href="#param-id-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase.</p>
|
|
133
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-1">Param: query<a href="#param-query-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
|
|
134
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-25">Throws<a href="#throws-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebaseHistoriesHttpError</p>
|
|
135
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getknowledgebases"><span>get<wbr/>Knowledgebases</span><a href="#getknowledgebases" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getKnowledgebases</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">countTotal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebasesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebasesHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Returns a list of all knowledgebases the user has access to.</p>
|
|
136
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">countTotal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebasesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebasesHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a list of all knowledgebases the user has access to.</p>
|
|
137
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">countTotal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
138
|
-
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">countTotal</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-2">Deprecated<a href="#deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Optional parameter to request total count for query</p>
|
|
139
|
-
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The number of knowledgebases to get.</p>
|
|
140
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Optional parameter to request the next page.</p>
|
|
141
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Optional parameter to request the previous page.</p>
|
|
142
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span></h5><div class="tsd-comment tsd-typography"><p>Optional resource field name to sort on, case insensitive, eg. name. Can be prefixed with - to set descending order, defaults to ascending.</p>
|
|
143
|
-
</div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.GetKnowledgebasesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetKnowledgebasesHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-26">Throws<a href="#throws-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebasesHttpError</p>
|
|
144
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-2">Param: query<a href="#param-query-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
|
|
145
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-27">Throws<a href="#throws-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetKnowledgebasesHttpError</p>
|
|
146
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchknowledgebase"><span>patch<wbr/>Knowledgebase</span><a href="#patchknowledgebase" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">patchKnowledgebase</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.JSONPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchArray</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.PatchKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates properties of a specific knowledgebase.</p>
|
|
147
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.JSONPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchArray</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.PatchKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates properties of a specific knowledgebase.</p>
|
|
148
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The knowledgebase id.</p>
|
|
149
|
-
</div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/knowledgebases.JSONPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchArray</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
150
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.PatchKnowledgebaseHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchKnowledgebaseHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-28">Throws<a href="#throws-28" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchKnowledgebaseHttpError</p>
|
|
151
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-12">Param: id<a href="#param-id-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The knowledgebase id.</p>
|
|
152
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-4">Param: body<a href="#param-body-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
153
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-29">Throws<a href="#throws-29" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchKnowledgebaseHttpError</p>
|
|
154
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="syncknowledgebasedatasource"><span>sync<wbr/>Knowledgebase<wbr/>Datasource</span><a href="#syncknowledgebasedatasource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">syncKnowledgebaseDatasource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">migrate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.SyncKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">SyncKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Starts syncing a specified datasource to a specified knowledgebase index.</p>
|
|
155
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">migrate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.SyncKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">SyncKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Starts syncing a specified datasource to a specified knowledgebase index.</p>
|
|
156
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
157
|
-
</div></li><li><span><span class="tsd-kind-parameter">datasourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the datasource to sync.</p>
|
|
158
|
-
</div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">migrate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
159
|
-
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">migrate</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Optional parameter to migrate indexed files to docdetails collection</p>
|
|
160
|
-
</div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.SyncKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">SyncKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-30">Throws<a href="#throws-30" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>SyncKnowledgebaseDatasourceHttpError</p>
|
|
161
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-13">Param: id<a href="#param-id-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the knowledgebase the datasource belongs to.</p>
|
|
162
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid-8">Param: datasourceId<a href="#param-datasourceid-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the datasource to sync.</p>
|
|
163
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-3">Param: query<a href="#param-query-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
|
|
164
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-31">Throws<a href="#throws-31" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>SyncKnowledgebaseDatasourceHttpError</p>
|
|
165
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updateknowledgebasedatasource"><span>update<wbr/>Knowledgebase<wbr/>Datasource</span><a href="#updateknowledgebasedatasource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">updateKnowledgebaseDatasource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.DataSource.html" class="tsd-signature-type tsd-kind-type-alias">DataSource</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.UpdateKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Update a knowledgebase datasource</p>
|
|
166
|
-
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">datasourceId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/knowledgebases.DataSource.html" class="tsd-signature-type tsd-kind-type-alias">DataSource</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.UpdateKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update a knowledgebase datasource</p>
|
|
167
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of a knowledgebase.</p>
|
|
168
|
-
</div></li><li><span><span class="tsd-kind-parameter">datasourceId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the datasource to update.</p>
|
|
169
|
-
</div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/knowledgebases.DataSource.html" class="tsd-signature-type tsd-kind-type-alias">DataSource</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
170
|
-
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/knowledgebases.UpdateKnowledgebaseDatasourceHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateKnowledgebaseDatasourceHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-32">Throws<a href="#throws-32" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>UpdateKnowledgebaseDatasourceHttpError</p>
|
|
171
|
-
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-14">Param: id<a href="#param-id-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of a knowledgebase.</p>
|
|
172
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-datasourceid-9">Param: datasourceId<a href="#param-datasourceid-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The id of the datasource to update.</p>
|
|
173
|
-
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-5">Param: body<a href="#param-body-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
174
|
-
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-33">Throws<a href="#throws-33" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>UpdateKnowledgebaseDatasourceHttpError</p>
|
|
175
|
-
</div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#cancelknowledgebasedatasource"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cancel<wbr/>Knowledgebase<wbr/>Datasource</span></a><a href="#clearcache"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clear<wbr/>Cache</span></a><a href="#createknowledgebase"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Knowledgebase</span></a><a href="#createknowledgebasedatasource"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Knowledgebase<wbr/>Datasource</span></a><a href="#createknowledgebasedatasourceschedule"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>create<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Schedule</span></a><a href="#deleteknowledgebase"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Knowledgebase</span></a><a href="#deleteknowledgebasedatasource"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Knowledgebase<wbr/>Datasource</span></a><a href="#deleteknowledgebasedatasourceschedule"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Schedule</span></a><a href="#downloadknowledgebasedatasource"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>download<wbr/>Knowledgebase<wbr/>Datasource</span></a><a href="#getknowledgebase"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebase</span></a><a href="#getknowledgebasedatasourcehistories"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Histories</span></a><a href="#getknowledgebasedatasourcehistory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebase<wbr/>Datasource<wbr/>History</span></a><a href="#getknowledgebasedatasourceschedule"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebase<wbr/>Datasource<wbr/>Schedule</span></a><a href="#getknowledgebasehistories"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebase<wbr/>Histories</span></a><a href="#getknowledgebases"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Knowledgebases</span></a><a href="#patchknowledgebase"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Knowledgebase</span></a><a href="#syncknowledgebasedatasource"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sync<wbr/>Knowledgebase<wbr/>Datasource</span></a><a href="#updateknowledgebasedatasource"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Knowledgebase<wbr/>Datasource</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy & Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>
|