@wildix/wim-knowledge-base-client 0.0.7

package/dist-types/commands/UpdateDataSourceCommand.d.ts

@@ -0,0 +1,168 @@
+import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
+import { UpdateDataSourceInput, UpdateDataSourceOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateDataSourceCommand}.
+ */
+export interface UpdateDataSourceCommandInput extends UpdateDataSourceInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateDataSourceCommand}.
+ */
+export interface UpdateDataSourceCommandOutput extends UpdateDataSourceOutput, __MetadataBearer {
+}
+declare const UpdateDataSourceCommand_base: {
+    new (input: UpdateDataSourceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateDataSourceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Update a data source by its ID
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KnowledgeBaseClient, UpdateDataSourceCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
+ * // const { KnowledgeBaseClient, UpdateDataSourceCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
+ * const client = new KnowledgeBaseClient(config);
+ * const input = { // UpdateDataSourceInput
+ *   name: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   type: "files" || "confluence" || "gdrive" || "proxy", // required
+ *   config: { // DataSourceConfig Union: only one key present
+ *     confluence: { // ConfluenceConfig
+ *       url: "STRING_VALUE", // required
+ *       username: "STRING_VALUE", // required
+ *       apiKey: "STRING_VALUE", // required
+ *       spaceId: "STRING_VALUE", // required
+ *       pages: { // ConfluencePagesConfig
+ *         enabled: [ // ConfluencePageIdsList // required
+ *           "STRING_VALUE",
+ *         ],
+ *         disabled: [ // required
+ *           "STRING_VALUE",
+ *         ],
+ *       },
+ *     },
+ *     gdrive: { // GDriveConfig
+ *       nangoConnectionId: "STRING_VALUE", // required
+ *       folders: { // GDriveFoldersConfig
+ *         enabled: [ // GDriveFolderIds // required
+ *           "STRING_VALUE",
+ *         ],
+ *         disabled: [ // required
+ *           "STRING_VALUE",
+ *         ],
+ *       },
+ *     },
+ *     files: { // UserFilesConfig
+ *       allowedExtensions: [ // StringList // required
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
+ *   enabled: true || false, // required
+ *   syncSchedule: "STRING_VALUE",
+ *   companyId: "STRING_VALUE",
+ *   dataSourceId: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateDataSourceCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateDataSourceOutput
+ * //   dataSource: { // DataSourceItem
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     type: "files" || "confluence" || "gdrive" || "proxy", // required
+ * //     config: { // DataSourceConfig Union: only one key present
+ * //       confluence: { // ConfluenceConfig
+ * //         url: "STRING_VALUE", // required
+ * //         username: "STRING_VALUE", // required
+ * //         apiKey: "STRING_VALUE", // required
+ * //         spaceId: "STRING_VALUE", // required
+ * //         pages: { // ConfluencePagesConfig
+ * //           enabled: [ // ConfluencePageIdsList // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           disabled: [ // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //       },
+ * //       gdrive: { // GDriveConfig
+ * //         nangoConnectionId: "STRING_VALUE", // required
+ * //         folders: { // GDriveFoldersConfig
+ * //           enabled: [ // GDriveFolderIds // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           disabled: [ // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //       },
+ * //       files: { // UserFilesConfig
+ * //         allowedExtensions: [ // StringList // required
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //     },
+ * //     enabled: true || false, // required
+ * //     syncSchedule: "STRING_VALUE",
+ * //     id: "STRING_VALUE", // required
+ * //     companyId: "STRING_VALUE", // required
+ * //     createdAt: "STRING_VALUE", // required
+ * //     updatedAt: "STRING_VALUE", // required
+ * //     syncStatus: "idle" || "running" || "success" || "failed", // required
+ * //     lastSyncedAt: "STRING_VALUE",
+ * //     lastSyncMode: "full" || "incremental" || "unknown",
+ * //     lastSyncErrorMessage: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateDataSourceCommandInput - {@link UpdateDataSourceCommandInput}
+ * @returns {@link UpdateDataSourceCommandOutput}
+ * @see {@link UpdateDataSourceCommandInput} for command's `input` shape.
+ * @see {@link UpdateDataSourceCommandOutput} for command's `response` shape.
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
+ *
+ * @throws {@link DataSourceNotFoundException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
+ *
+ * @throws {@link DocumentNotFoundException} (client fault)
+ *
+ * @throws {@link KnowledgeBaseServiceException}
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateDataSourceCommand extends UpdateDataSourceCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateDataSourceInput;
+            output: UpdateDataSourceOutput;
+        };
+        sdk: {
+            input: UpdateDataSourceCommandInput;
+            output: UpdateDataSourceCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateDocumentCommand.d.ts

@@ -0,0 +1,108 @@
+import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
+import { UpdateDocumentInput, UpdateDocumentOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateDocumentCommand}.
+ */
+export interface UpdateDocumentCommandInput extends UpdateDocumentInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateDocumentCommand}.
+ */
+export interface UpdateDocumentCommandOutput extends UpdateDocumentOutput, __MetadataBearer {
+}
+declare const UpdateDocumentCommand_base: {
+    new (input: UpdateDocumentCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDocumentCommandInput, UpdateDocumentCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateDocumentCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDocumentCommandInput, UpdateDocumentCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Update a document by its ID
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KnowledgeBaseClient, UpdateDocumentCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
+ * // const { KnowledgeBaseClient, UpdateDocumentCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
+ * const client = new KnowledgeBaseClient(config);
+ * const input = { // UpdateDocumentInput
+ *   title: "STRING_VALUE", // required
+ *   url: "STRING_VALUE",
+ *   content: "STRING_VALUE",
+ *   originalFormat: "STRING_VALUE", // required
+ *   originalName: "STRING_VALUE", // required
+ *   originalId: "STRING_VALUE",
+ *   companyId: "STRING_VALUE",
+ *   dataSourceId: "STRING_VALUE", // required
+ *   documentId: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateDocumentCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateDocumentOutput
+ * //   document: { // DocumentItem
+ * //     title: "STRING_VALUE", // required
+ * //     url: "STRING_VALUE",
+ * //     content: "STRING_VALUE",
+ * //     originalFormat: "STRING_VALUE", // required
+ * //     originalName: "STRING_VALUE", // required
+ * //     originalId: "STRING_VALUE",
+ * //     id: "STRING_VALUE", // required
+ * //     companyId: "STRING_VALUE", // required
+ * //     dataSourceId: "STRING_VALUE", // required
+ * //     s3OriginalKey: "STRING_VALUE",
+ * //     s3MarkdownKey: "STRING_VALUE",
+ * //     createdAt: "STRING_VALUE", // required
+ * //     updatedAt: "STRING_VALUE", // required
+ * //     status: "pending" || "processing" || "completed" || "failed", // required
+ * //     errorMessage: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateDocumentCommandInput - {@link UpdateDocumentCommandInput}
+ * @returns {@link UpdateDocumentCommandOutput}
+ * @see {@link UpdateDocumentCommandInput} for command's `input` shape.
+ * @see {@link UpdateDocumentCommandOutput} for command's `response` shape.
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
+ *
+ * @throws {@link DocumentNotFoundException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
+ *
+ * @throws {@link DataSourceNotFoundException} (client fault)
+ *
+ * @throws {@link KnowledgeBaseServiceException}
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateDocumentCommand extends UpdateDocumentCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateDocumentInput;
+            output: UpdateDocumentOutput;
+        };
+        sdk: {
+            input: UpdateDocumentCommandInput;
+            output: UpdateDocumentCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts

@@ -0,0 +1,100 @@
+import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
+import { UpdateKnowledgeBaseInput, UpdateKnowledgeBaseOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateKnowledgeBaseCommand}.
+ */
+export interface UpdateKnowledgeBaseCommandInput extends UpdateKnowledgeBaseInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateKnowledgeBaseCommand}.
+ */
+export interface UpdateKnowledgeBaseCommandOutput extends UpdateKnowledgeBaseOutput, __MetadataBearer {
+}
+declare const UpdateKnowledgeBaseCommand_base: {
+    new (input: UpdateKnowledgeBaseCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateKnowledgeBaseCommandInput, UpdateKnowledgeBaseCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateKnowledgeBaseCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateKnowledgeBaseCommandInput, UpdateKnowledgeBaseCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * Update a knowledge base by its ID
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KnowledgeBaseClient, UpdateKnowledgeBaseCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
+ * // const { KnowledgeBaseClient, UpdateKnowledgeBaseCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
+ * const client = new KnowledgeBaseClient(config);
+ * const input = { // UpdateKnowledgeBaseInput
+ *   name: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   dataSources: [ // DataSourceIdsList // required
+ *     "STRING_VALUE",
+ *   ],
+ *   companyId: "STRING_VALUE",
+ *   knowledgeBaseId: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateKnowledgeBaseCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateKnowledgeBaseOutput
+ * //   knowledgeBase: { // KnowledgeBaseItem
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     dataSources: [ // DataSourceIdsList // required
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     id: "STRING_VALUE", // required
+ * //     companyId: "STRING_VALUE", // required
+ * //     createdAt: "STRING_VALUE", // required
+ * //     updatedAt: "STRING_VALUE", // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateKnowledgeBaseCommandInput - {@link UpdateKnowledgeBaseCommandInput}
+ * @returns {@link UpdateKnowledgeBaseCommandOutput}
+ * @see {@link UpdateKnowledgeBaseCommandInput} for command's `input` shape.
+ * @see {@link UpdateKnowledgeBaseCommandOutput} for command's `response` shape.
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
+ *
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link DataSourceNotFoundException} (client fault)
+ *
+ * @throws {@link DocumentNotFoundException} (client fault)
+ *
+ * @throws {@link KnowledgeBaseServiceException}
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateKnowledgeBaseCommand extends UpdateKnowledgeBaseCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateKnowledgeBaseInput;
+            output: UpdateKnowledgeBaseOutput;
+        };
+        sdk: {
+            input: UpdateKnowledgeBaseCommandInput;
+            output: UpdateKnowledgeBaseCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -0,0 +1,23 @@
+export * from "./CreateDataSourceCommand";
+export * from "./CreateDocumentCommand";
+export * from "./CreateKnowledgeBaseCommand";
+export * from "./DeleteDataSourceCommand";
+export * from "./DeleteDocumentCommand";
+export * from "./DeleteKnowledgeBaseCommand";
+export * from "./GetAuthorizationSessionForDataSourceCommand";
+export * from "./GetDataSourceCommand";
+export * from "./GetDocumentCommand";
+export * from "./GetDocumentPresignedDownloadUrlCommand";
+export * from "./GetDocumentPresignedUploadUrlCommand";
+export * from "./GetKnowledgeBaseCommand";
+export * from "./GetSyncLogsCommand";
+export * from "./GetSyncStatusCommand";
+export * from "./ListDataSourcesCommand";
+export * from "./ListDocumentsCommand";
+export * from "./ListKnowledgeBasesCommand";
+export * from "./QueryKnowledgeBaseCommand";
+export * from "./SearchKnowledgeBaseCommand";
+export * from "./SyncDataSourceCommand";
+export * from "./UpdateDataSourceCommand";
+export * from "./UpdateDocumentCommand";
+export * from "./UpdateKnowledgeBaseCommand";

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,7 @@
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface KnowledgeBaseExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./KnowledgeBaseClient";
+export * from "./KnowledgeBase";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { KnowledgeBaseExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./models";
+export { KnowledgeBaseServiceException } from "./models/KnowledgeBaseServiceException";

package/dist-types/models/KnowledgeBaseServiceException.d.ts

@@ -0,0 +1,14 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from KnowledgeBase service.
+ */
+export declare class KnowledgeBaseServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/index.d.ts

@@ -0,0 +1 @@
+export * from "./models_0";