@wildix/wim-knowledge-base-client 0.0.7

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.
Files changed (112) hide show
  1. package/dist-cjs/KnowledgeBase.js +57 -0
  2. package/dist-cjs/KnowledgeBaseClient.js +41 -0
  3. package/dist-cjs/commands/CreateDataSourceCommand.js +21 -0
  4. package/dist-cjs/commands/CreateDocumentCommand.js +21 -0
  5. package/dist-cjs/commands/CreateKnowledgeBaseCommand.js +21 -0
  6. package/dist-cjs/commands/DeleteDataSourceCommand.js +21 -0
  7. package/dist-cjs/commands/DeleteDocumentCommand.js +21 -0
  8. package/dist-cjs/commands/DeleteKnowledgeBaseCommand.js +21 -0
  9. package/dist-cjs/commands/GetAuthorizationSessionForDataSourceCommand.js +21 -0
  10. package/dist-cjs/commands/GetDataSourceCommand.js +21 -0
  11. package/dist-cjs/commands/GetDocumentCommand.js +21 -0
  12. package/dist-cjs/commands/GetDocumentPresignedDownloadUrlCommand.js +21 -0
  13. package/dist-cjs/commands/GetDocumentPresignedUploadUrlCommand.js +21 -0
  14. package/dist-cjs/commands/GetKnowledgeBaseCommand.js +21 -0
  15. package/dist-cjs/commands/GetSyncLogsCommand.js +21 -0
  16. package/dist-cjs/commands/GetSyncStatusCommand.js +21 -0
  17. package/dist-cjs/commands/ListDataSourcesCommand.js +21 -0
  18. package/dist-cjs/commands/ListDocumentsCommand.js +21 -0
  19. package/dist-cjs/commands/ListKnowledgeBasesCommand.js +21 -0
  20. package/dist-cjs/commands/QueryKnowledgeBaseCommand.js +21 -0
  21. package/dist-cjs/commands/SearchKnowledgeBaseCommand.js +21 -0
  22. package/dist-cjs/commands/SyncDataSourceCommand.js +21 -0
  23. package/dist-cjs/commands/UpdateDataSourceCommand.js +21 -0
  24. package/dist-cjs/commands/UpdateDocumentCommand.js +21 -0
  25. package/dist-cjs/commands/UpdateKnowledgeBaseCommand.js +21 -0
  26. package/dist-cjs/commands/index.js +26 -0
  27. package/dist-cjs/extensionConfiguration.js +2 -0
  28. package/dist-cjs/index.js +10 -0
  29. package/dist-cjs/models/KnowledgeBaseServiceException.js +12 -0
  30. package/dist-cjs/models/index.js +4 -0
  31. package/dist-cjs/models/models_0.js +132 -0
  32. package/dist-cjs/protocols/Aws_restJson1.js +936 -0
  33. package/dist-cjs/runtimeConfig.browser.js +32 -0
  34. package/dist-cjs/runtimeConfig.js +37 -0
  35. package/dist-cjs/runtimeConfig.native.js +15 -0
  36. package/dist-cjs/runtimeConfig.shared.js +21 -0
  37. package/dist-cjs/runtimeExtensions.js +11 -0
  38. package/dist-es/KnowledgeBase.js +53 -0
  39. package/dist-es/KnowledgeBaseClient.js +37 -0
  40. package/dist-es/commands/CreateDataSourceCommand.js +17 -0
  41. package/dist-es/commands/CreateDocumentCommand.js +17 -0
  42. package/dist-es/commands/CreateKnowledgeBaseCommand.js +17 -0
  43. package/dist-es/commands/DeleteDataSourceCommand.js +17 -0
  44. package/dist-es/commands/DeleteDocumentCommand.js +17 -0
  45. package/dist-es/commands/DeleteKnowledgeBaseCommand.js +17 -0
  46. package/dist-es/commands/GetAuthorizationSessionForDataSourceCommand.js +17 -0
  47. package/dist-es/commands/GetDataSourceCommand.js +17 -0
  48. package/dist-es/commands/GetDocumentCommand.js +17 -0
  49. package/dist-es/commands/GetDocumentPresignedDownloadUrlCommand.js +17 -0
  50. package/dist-es/commands/GetDocumentPresignedUploadUrlCommand.js +17 -0
  51. package/dist-es/commands/GetKnowledgeBaseCommand.js +17 -0
  52. package/dist-es/commands/GetSyncLogsCommand.js +17 -0
  53. package/dist-es/commands/GetSyncStatusCommand.js +17 -0
  54. package/dist-es/commands/ListDataSourcesCommand.js +17 -0
  55. package/dist-es/commands/ListDocumentsCommand.js +17 -0
  56. package/dist-es/commands/ListKnowledgeBasesCommand.js +17 -0
  57. package/dist-es/commands/QueryKnowledgeBaseCommand.js +17 -0
  58. package/dist-es/commands/SearchKnowledgeBaseCommand.js +17 -0
  59. package/dist-es/commands/SyncDataSourceCommand.js +17 -0
  60. package/dist-es/commands/UpdateDataSourceCommand.js +17 -0
  61. package/dist-es/commands/UpdateDocumentCommand.js +17 -0
  62. package/dist-es/commands/UpdateKnowledgeBaseCommand.js +17 -0
  63. package/dist-es/commands/index.js +23 -0
  64. package/dist-es/extensionConfiguration.js +1 -0
  65. package/dist-es/index.js +5 -0
  66. package/dist-es/models/KnowledgeBaseServiceException.js +8 -0
  67. package/dist-es/models/index.js +1 -0
  68. package/dist-es/models/models_0.js +123 -0
  69. package/dist-es/protocols/Aws_restJson1.js +887 -0
  70. package/dist-es/runtimeConfig.browser.js +27 -0
  71. package/dist-es/runtimeConfig.js +32 -0
  72. package/dist-es/runtimeConfig.native.js +11 -0
  73. package/dist-es/runtimeConfig.shared.js +17 -0
  74. package/dist-es/runtimeExtensions.js +7 -0
  75. package/dist-types/KnowledgeBase.d.ts +172 -0
  76. package/dist-types/KnowledgeBaseClient.d.ts +166 -0
  77. package/dist-types/commands/CreateDataSourceCommand.d.ts +167 -0
  78. package/dist-types/commands/CreateDocumentCommand.d.ts +107 -0
  79. package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +99 -0
  80. package/dist-types/commands/DeleteDataSourceCommand.d.ts +83 -0
  81. package/dist-types/commands/DeleteDocumentCommand.d.ts +84 -0
  82. package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +83 -0
  83. package/dist-types/commands/GetAuthorizationSessionForDataSourceCommand.d.ts +85 -0
  84. package/dist-types/commands/GetDataSourceCommand.d.ts +131 -0
  85. package/dist-types/commands/GetDocumentCommand.d.ts +102 -0
  86. package/dist-types/commands/GetDocumentPresignedDownloadUrlCommand.d.ts +87 -0
  87. package/dist-types/commands/GetDocumentPresignedUploadUrlCommand.d.ts +86 -0
  88. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +95 -0
  89. package/dist-types/commands/GetSyncLogsCommand.d.ts +91 -0
  90. package/dist-types/commands/GetSyncStatusCommand.d.ts +87 -0
  91. package/dist-types/commands/ListDataSourcesCommand.d.ts +132 -0
  92. package/dist-types/commands/ListDocumentsCommand.d.ts +103 -0
  93. package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +96 -0
  94. package/dist-types/commands/QueryKnowledgeBaseCommand.d.ts +98 -0
  95. package/dist-types/commands/SearchKnowledgeBaseCommand.d.ts +99 -0
  96. package/dist-types/commands/SyncDataSourceCommand.d.ts +84 -0
  97. package/dist-types/commands/UpdateDataSourceCommand.d.ts +168 -0
  98. package/dist-types/commands/UpdateDocumentCommand.d.ts +108 -0
  99. package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +100 -0
  100. package/dist-types/commands/index.d.ts +23 -0
  101. package/dist-types/extensionConfiguration.d.ts +7 -0
  102. package/dist-types/index.d.ts +7 -0
  103. package/dist-types/models/KnowledgeBaseServiceException.d.ts +14 -0
  104. package/dist-types/models/index.d.ts +1 -0
  105. package/dist-types/models/models_0.d.ts +981 -0
  106. package/dist-types/protocols/Aws_restJson1.d.ts +209 -0
  107. package/dist-types/runtimeConfig.browser.d.ts +31 -0
  108. package/dist-types/runtimeConfig.d.ts +31 -0
  109. package/dist-types/runtimeConfig.native.d.ts +30 -0
  110. package/dist-types/runtimeConfig.shared.d.ts +15 -0
  111. package/dist-types/runtimeExtensions.d.ts +17 -0
  112. package/package.json +83 -0
@@ -0,0 +1,102 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { GetDocumentInput, GetDocumentOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetDocumentCommand}.
14
+ */
15
+ export interface GetDocumentCommandInput extends GetDocumentInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetDocumentCommand}.
21
+ */
22
+ export interface GetDocumentCommandOutput extends GetDocumentOutput, __MetadataBearer {
23
+ }
24
+ declare const GetDocumentCommand_base: {
25
+ new (input: GetDocumentCommandInput): import("@smithy/smithy-client").CommandImpl<GetDocumentCommandInput, GetDocumentCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetDocumentCommandInput): import("@smithy/smithy-client").CommandImpl<GetDocumentCommandInput, GetDocumentCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Get a document by its ID
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KnowledgeBaseClient, GetDocumentCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, GetDocumentCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // GetDocumentInput
38
+ * companyId: "STRING_VALUE",
39
+ * dataSourceId: "STRING_VALUE", // required
40
+ * documentId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new GetDocumentCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // GetDocumentOutput
45
+ * // document: { // DocumentItem
46
+ * // title: "STRING_VALUE", // required
47
+ * // url: "STRING_VALUE",
48
+ * // content: "STRING_VALUE",
49
+ * // originalFormat: "STRING_VALUE", // required
50
+ * // originalName: "STRING_VALUE", // required
51
+ * // originalId: "STRING_VALUE",
52
+ * // id: "STRING_VALUE", // required
53
+ * // companyId: "STRING_VALUE", // required
54
+ * // dataSourceId: "STRING_VALUE", // required
55
+ * // s3OriginalKey: "STRING_VALUE",
56
+ * // s3MarkdownKey: "STRING_VALUE",
57
+ * // createdAt: "STRING_VALUE", // required
58
+ * // updatedAt: "STRING_VALUE", // required
59
+ * // status: "pending" || "processing" || "completed" || "failed", // required
60
+ * // errorMessage: "STRING_VALUE",
61
+ * // },
62
+ * // };
63
+ *
64
+ * ```
65
+ *
66
+ * @param GetDocumentCommandInput - {@link GetDocumentCommandInput}
67
+ * @returns {@link GetDocumentCommandOutput}
68
+ * @see {@link GetDocumentCommandInput} for command's `input` shape.
69
+ * @see {@link GetDocumentCommandOutput} for command's `response` shape.
70
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
71
+ *
72
+ * @throws {@link DocumentNotFoundException} (client fault)
73
+ *
74
+ * @throws {@link UnauthorizedException} (client fault)
75
+ *
76
+ * @throws {@link ForbiddenException} (client fault)
77
+ *
78
+ * @throws {@link ValidationException} (client fault)
79
+ *
80
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
81
+ *
82
+ * @throws {@link DataSourceNotFoundException} (client fault)
83
+ *
84
+ * @throws {@link KnowledgeBaseServiceException}
85
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
86
+ *
87
+ *
88
+ * @public
89
+ */
90
+ export declare class GetDocumentCommand extends GetDocumentCommand_base {
91
+ /** @internal type navigation helper, not in runtime. */
92
+ protected static __types: {
93
+ api: {
94
+ input: GetDocumentInput;
95
+ output: GetDocumentOutput;
96
+ };
97
+ sdk: {
98
+ input: GetDocumentCommandInput;
99
+ output: GetDocumentCommandOutput;
100
+ };
101
+ };
102
+ }
@@ -0,0 +1,87 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { GetDocumentPresignedDownloadUrlInput, GetDocumentPresignedDownloadUrlOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetDocumentPresignedDownloadUrlCommand}.
14
+ */
15
+ export interface GetDocumentPresignedDownloadUrlCommandInput extends GetDocumentPresignedDownloadUrlInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetDocumentPresignedDownloadUrlCommand}.
21
+ */
22
+ export interface GetDocumentPresignedDownloadUrlCommandOutput extends GetDocumentPresignedDownloadUrlOutput, __MetadataBearer {
23
+ }
24
+ declare const GetDocumentPresignedDownloadUrlCommand_base: {
25
+ new (input: GetDocumentPresignedDownloadUrlCommandInput): import("@smithy/smithy-client").CommandImpl<GetDocumentPresignedDownloadUrlCommandInput, GetDocumentPresignedDownloadUrlCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetDocumentPresignedDownloadUrlCommandInput): import("@smithy/smithy-client").CommandImpl<GetDocumentPresignedDownloadUrlCommandInput, GetDocumentPresignedDownloadUrlCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Get a presigned URL for downloading the original file of the document
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KnowledgeBaseClient, GetDocumentPresignedDownloadUrlCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, GetDocumentPresignedDownloadUrlCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // GetDocumentPresignedDownloadUrlInput
38
+ * companyId: "STRING_VALUE",
39
+ * dataSourceId: "STRING_VALUE", // required
40
+ * documentId: "STRING_VALUE", // required
41
+ * documentType: "original" || "markdown",
42
+ * };
43
+ * const command = new GetDocumentPresignedDownloadUrlCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // GetDocumentPresignedDownloadUrlOutput
46
+ * // presignedDownloadUrl: "STRING_VALUE", // required
47
+ * // };
48
+ *
49
+ * ```
50
+ *
51
+ * @param GetDocumentPresignedDownloadUrlCommandInput - {@link GetDocumentPresignedDownloadUrlCommandInput}
52
+ * @returns {@link GetDocumentPresignedDownloadUrlCommandOutput}
53
+ * @see {@link GetDocumentPresignedDownloadUrlCommandInput} for command's `input` shape.
54
+ * @see {@link GetDocumentPresignedDownloadUrlCommandOutput} for command's `response` shape.
55
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
56
+ *
57
+ * @throws {@link DocumentNotFoundException} (client fault)
58
+ *
59
+ * @throws {@link UnauthorizedException} (client fault)
60
+ *
61
+ * @throws {@link ForbiddenException} (client fault)
62
+ *
63
+ * @throws {@link ValidationException} (client fault)
64
+ *
65
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
66
+ *
67
+ * @throws {@link DataSourceNotFoundException} (client fault)
68
+ *
69
+ * @throws {@link KnowledgeBaseServiceException}
70
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
71
+ *
72
+ *
73
+ * @public
74
+ */
75
+ export declare class GetDocumentPresignedDownloadUrlCommand extends GetDocumentPresignedDownloadUrlCommand_base {
76
+ /** @internal type navigation helper, not in runtime. */
77
+ protected static __types: {
78
+ api: {
79
+ input: GetDocumentPresignedDownloadUrlInput;
80
+ output: GetDocumentPresignedDownloadUrlOutput;
81
+ };
82
+ sdk: {
83
+ input: GetDocumentPresignedDownloadUrlCommandInput;
84
+ output: GetDocumentPresignedDownloadUrlCommandOutput;
85
+ };
86
+ };
87
+ }
@@ -0,0 +1,86 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { GetDocumentPresignedUploadUrlInput, GetDocumentPresignedUploadUrlOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetDocumentPresignedUploadUrlCommand}.
14
+ */
15
+ export interface GetDocumentPresignedUploadUrlCommandInput extends GetDocumentPresignedUploadUrlInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetDocumentPresignedUploadUrlCommand}.
21
+ */
22
+ export interface GetDocumentPresignedUploadUrlCommandOutput extends GetDocumentPresignedUploadUrlOutput, __MetadataBearer {
23
+ }
24
+ declare const GetDocumentPresignedUploadUrlCommand_base: {
25
+ new (input: GetDocumentPresignedUploadUrlCommandInput): import("@smithy/smithy-client").CommandImpl<GetDocumentPresignedUploadUrlCommandInput, GetDocumentPresignedUploadUrlCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetDocumentPresignedUploadUrlCommandInput): import("@smithy/smithy-client").CommandImpl<GetDocumentPresignedUploadUrlCommandInput, GetDocumentPresignedUploadUrlCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Get a presigned URL for uploading the original file of the document
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KnowledgeBaseClient, GetDocumentPresignedUploadUrlCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, GetDocumentPresignedUploadUrlCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // GetDocumentPresignedUploadUrlInput
38
+ * companyId: "STRING_VALUE",
39
+ * dataSourceId: "STRING_VALUE", // required
40
+ * documentId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new GetDocumentPresignedUploadUrlCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // GetDocumentPresignedUploadUrlOutput
45
+ * // presignedUploadUrl: "STRING_VALUE", // required
46
+ * // };
47
+ *
48
+ * ```
49
+ *
50
+ * @param GetDocumentPresignedUploadUrlCommandInput - {@link GetDocumentPresignedUploadUrlCommandInput}
51
+ * @returns {@link GetDocumentPresignedUploadUrlCommandOutput}
52
+ * @see {@link GetDocumentPresignedUploadUrlCommandInput} for command's `input` shape.
53
+ * @see {@link GetDocumentPresignedUploadUrlCommandOutput} for command's `response` shape.
54
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
55
+ *
56
+ * @throws {@link DocumentNotFoundException} (client fault)
57
+ *
58
+ * @throws {@link UnauthorizedException} (client fault)
59
+ *
60
+ * @throws {@link ForbiddenException} (client fault)
61
+ *
62
+ * @throws {@link ValidationException} (client fault)
63
+ *
64
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
65
+ *
66
+ * @throws {@link DataSourceNotFoundException} (client fault)
67
+ *
68
+ * @throws {@link KnowledgeBaseServiceException}
69
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
70
+ *
71
+ *
72
+ * @public
73
+ */
74
+ export declare class GetDocumentPresignedUploadUrlCommand extends GetDocumentPresignedUploadUrlCommand_base {
75
+ /** @internal type navigation helper, not in runtime. */
76
+ protected static __types: {
77
+ api: {
78
+ input: GetDocumentPresignedUploadUrlInput;
79
+ output: GetDocumentPresignedUploadUrlOutput;
80
+ };
81
+ sdk: {
82
+ input: GetDocumentPresignedUploadUrlCommandInput;
83
+ output: GetDocumentPresignedUploadUrlCommandOutput;
84
+ };
85
+ };
86
+ }
@@ -0,0 +1,95 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { GetKnowledgeBaseInput, GetKnowledgeBaseOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetKnowledgeBaseCommand}.
14
+ */
15
+ export interface GetKnowledgeBaseCommandInput extends GetKnowledgeBaseInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetKnowledgeBaseCommand}.
21
+ */
22
+ export interface GetKnowledgeBaseCommandOutput extends GetKnowledgeBaseOutput, __MetadataBearer {
23
+ }
24
+ declare const GetKnowledgeBaseCommand_base: {
25
+ new (input: GetKnowledgeBaseCommandInput): import("@smithy/smithy-client").CommandImpl<GetKnowledgeBaseCommandInput, GetKnowledgeBaseCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetKnowledgeBaseCommandInput): import("@smithy/smithy-client").CommandImpl<GetKnowledgeBaseCommandInput, GetKnowledgeBaseCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Get a knowledge base by its ID
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KnowledgeBaseClient, GetKnowledgeBaseCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, GetKnowledgeBaseCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // GetKnowledgeBaseInput
38
+ * companyId: "STRING_VALUE",
39
+ * knowledgeBaseId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetKnowledgeBaseCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetKnowledgeBaseOutput
44
+ * // knowledgeBase: { // KnowledgeBaseItem
45
+ * // name: "STRING_VALUE", // required
46
+ * // description: "STRING_VALUE",
47
+ * // dataSources: [ // DataSourceIdsList // required
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // id: "STRING_VALUE", // required
51
+ * // companyId: "STRING_VALUE", // required
52
+ * // createdAt: "STRING_VALUE", // required
53
+ * // updatedAt: "STRING_VALUE", // required
54
+ * // },
55
+ * // };
56
+ *
57
+ * ```
58
+ *
59
+ * @param GetKnowledgeBaseCommandInput - {@link GetKnowledgeBaseCommandInput}
60
+ * @returns {@link GetKnowledgeBaseCommandOutput}
61
+ * @see {@link GetKnowledgeBaseCommandInput} for command's `input` shape.
62
+ * @see {@link GetKnowledgeBaseCommandOutput} for command's `response` shape.
63
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
64
+ *
65
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
66
+ *
67
+ * @throws {@link UnauthorizedException} (client fault)
68
+ *
69
+ * @throws {@link ForbiddenException} (client fault)
70
+ *
71
+ * @throws {@link ValidationException} (client fault)
72
+ *
73
+ * @throws {@link DataSourceNotFoundException} (client fault)
74
+ *
75
+ * @throws {@link DocumentNotFoundException} (client fault)
76
+ *
77
+ * @throws {@link KnowledgeBaseServiceException}
78
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
79
+ *
80
+ *
81
+ * @public
82
+ */
83
+ export declare class GetKnowledgeBaseCommand extends GetKnowledgeBaseCommand_base {
84
+ /** @internal type navigation helper, not in runtime. */
85
+ protected static __types: {
86
+ api: {
87
+ input: GetKnowledgeBaseInput;
88
+ output: GetKnowledgeBaseOutput;
89
+ };
90
+ sdk: {
91
+ input: GetKnowledgeBaseCommandInput;
92
+ output: GetKnowledgeBaseCommandOutput;
93
+ };
94
+ };
95
+ }
@@ -0,0 +1,91 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { GetSyncLogsInput, GetSyncLogsOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetSyncLogsCommand}.
14
+ */
15
+ export interface GetSyncLogsCommandInput extends GetSyncLogsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetSyncLogsCommand}.
21
+ */
22
+ export interface GetSyncLogsCommandOutput extends GetSyncLogsOutput, __MetadataBearer {
23
+ }
24
+ declare const GetSyncLogsCommand_base: {
25
+ new (input: GetSyncLogsCommandInput): import("@smithy/smithy-client").CommandImpl<GetSyncLogsCommandInput, GetSyncLogsCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetSyncLogsCommandInput): import("@smithy/smithy-client").CommandImpl<GetSyncLogsCommandInput, GetSyncLogsCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Get the sync logs of a data source by its ID
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KnowledgeBaseClient, GetSyncLogsCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, GetSyncLogsCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // GetSyncLogsInput
38
+ * companyId: "STRING_VALUE",
39
+ * dataSourceId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetSyncLogsCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetSyncLogsOutput
44
+ * // logs: [ // SyncLogList // required
45
+ * // { // SyncLogItem
46
+ * // timestamp: "STRING_VALUE", // required
47
+ * // level: "debug" || "info" || "warn" || "error", // required
48
+ * // message: "STRING_VALUE", // required
49
+ * // },
50
+ * // ],
51
+ * // };
52
+ *
53
+ * ```
54
+ *
55
+ * @param GetSyncLogsCommandInput - {@link GetSyncLogsCommandInput}
56
+ * @returns {@link GetSyncLogsCommandOutput}
57
+ * @see {@link GetSyncLogsCommandInput} for command's `input` shape.
58
+ * @see {@link GetSyncLogsCommandOutput} for command's `response` shape.
59
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
60
+ *
61
+ * @throws {@link DataSourceNotFoundException} (client fault)
62
+ *
63
+ * @throws {@link UnauthorizedException} (client fault)
64
+ *
65
+ * @throws {@link ForbiddenException} (client fault)
66
+ *
67
+ * @throws {@link ValidationException} (client fault)
68
+ *
69
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
70
+ *
71
+ * @throws {@link DocumentNotFoundException} (client fault)
72
+ *
73
+ * @throws {@link KnowledgeBaseServiceException}
74
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
75
+ *
76
+ *
77
+ * @public
78
+ */
79
+ export declare class GetSyncLogsCommand extends GetSyncLogsCommand_base {
80
+ /** @internal type navigation helper, not in runtime. */
81
+ protected static __types: {
82
+ api: {
83
+ input: GetSyncLogsInput;
84
+ output: GetSyncLogsOutput;
85
+ };
86
+ sdk: {
87
+ input: GetSyncLogsCommandInput;
88
+ output: GetSyncLogsCommandOutput;
89
+ };
90
+ };
91
+ }
@@ -0,0 +1,87 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { GetSyncStatusInput, GetSyncStatusOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetSyncStatusCommand}.
14
+ */
15
+ export interface GetSyncStatusCommandInput extends GetSyncStatusInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetSyncStatusCommand}.
21
+ */
22
+ export interface GetSyncStatusCommandOutput extends GetSyncStatusOutput, __MetadataBearer {
23
+ }
24
+ declare const GetSyncStatusCommand_base: {
25
+ new (input: GetSyncStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetSyncStatusCommandInput, GetSyncStatusCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetSyncStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetSyncStatusCommandInput, GetSyncStatusCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Get the sync status of a data source by its ID
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KnowledgeBaseClient, GetSyncStatusCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, GetSyncStatusCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // GetSyncStatusInput
38
+ * companyId: "STRING_VALUE",
39
+ * dataSourceId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetSyncStatusCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetSyncStatusOutput
44
+ * // syncStatus: "idle" || "running" || "success" || "failed", // required
45
+ * // progress: Number("int"),
46
+ * // syncErrorMessage: "STRING_VALUE",
47
+ * // };
48
+ *
49
+ * ```
50
+ *
51
+ * @param GetSyncStatusCommandInput - {@link GetSyncStatusCommandInput}
52
+ * @returns {@link GetSyncStatusCommandOutput}
53
+ * @see {@link GetSyncStatusCommandInput} for command's `input` shape.
54
+ * @see {@link GetSyncStatusCommandOutput} for command's `response` shape.
55
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
56
+ *
57
+ * @throws {@link DataSourceNotFoundException} (client fault)
58
+ *
59
+ * @throws {@link UnauthorizedException} (client fault)
60
+ *
61
+ * @throws {@link ForbiddenException} (client fault)
62
+ *
63
+ * @throws {@link ValidationException} (client fault)
64
+ *
65
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
66
+ *
67
+ * @throws {@link DocumentNotFoundException} (client fault)
68
+ *
69
+ * @throws {@link KnowledgeBaseServiceException}
70
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
71
+ *
72
+ *
73
+ * @public
74
+ */
75
+ export declare class GetSyncStatusCommand extends GetSyncStatusCommand_base {
76
+ /** @internal type navigation helper, not in runtime. */
77
+ protected static __types: {
78
+ api: {
79
+ input: GetSyncStatusInput;
80
+ output: GetSyncStatusOutput;
81
+ };
82
+ sdk: {
83
+ input: GetSyncStatusCommandInput;
84
+ output: GetSyncStatusCommandOutput;
85
+ };
86
+ };
87
+ }