@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,107 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { CreateDocumentInput, CreateDocumentOutput } 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 CreateDocumentCommand}.
14
+ */
15
+ export interface CreateDocumentCommandInput extends CreateDocumentInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateDocumentCommand}.
21
+ */
22
+ export interface CreateDocumentCommandOutput extends CreateDocumentOutput, __MetadataBearer {
23
+ }
24
+ declare const CreateDocumentCommand_base: {
25
+ new (input: CreateDocumentCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDocumentCommandInput, CreateDocumentCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateDocumentCommandInput): import("@smithy/smithy-client").CommandImpl<CreateDocumentCommandInput, CreateDocumentCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Create a new document for 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, CreateDocumentCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, CreateDocumentCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // CreateDocumentInput
38
+ * title: "STRING_VALUE", // required
39
+ * url: "STRING_VALUE",
40
+ * content: "STRING_VALUE",
41
+ * originalFormat: "STRING_VALUE", // required
42
+ * originalName: "STRING_VALUE", // required
43
+ * originalId: "STRING_VALUE",
44
+ * companyId: "STRING_VALUE",
45
+ * dataSourceId: "STRING_VALUE", // required
46
+ * };
47
+ * const command = new CreateDocumentCommand(input);
48
+ * const response = await client.send(command);
49
+ * // { // CreateDocumentOutput
50
+ * // document: { // DocumentItem
51
+ * // title: "STRING_VALUE", // required
52
+ * // url: "STRING_VALUE",
53
+ * // content: "STRING_VALUE",
54
+ * // originalFormat: "STRING_VALUE", // required
55
+ * // originalName: "STRING_VALUE", // required
56
+ * // originalId: "STRING_VALUE",
57
+ * // id: "STRING_VALUE", // required
58
+ * // companyId: "STRING_VALUE", // required
59
+ * // dataSourceId: "STRING_VALUE", // required
60
+ * // s3OriginalKey: "STRING_VALUE",
61
+ * // s3MarkdownKey: "STRING_VALUE",
62
+ * // createdAt: "STRING_VALUE", // required
63
+ * // updatedAt: "STRING_VALUE", // required
64
+ * // status: "pending" || "processing" || "completed" || "failed", // required
65
+ * // errorMessage: "STRING_VALUE",
66
+ * // },
67
+ * // };
68
+ *
69
+ * ```
70
+ *
71
+ * @param CreateDocumentCommandInput - {@link CreateDocumentCommandInput}
72
+ * @returns {@link CreateDocumentCommandOutput}
73
+ * @see {@link CreateDocumentCommandInput} for command's `input` shape.
74
+ * @see {@link CreateDocumentCommandOutput} for command's `response` shape.
75
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
76
+ *
77
+ * @throws {@link ValidationException} (client fault)
78
+ *
79
+ * @throws {@link UnauthorizedException} (client fault)
80
+ *
81
+ * @throws {@link ForbiddenException} (client fault)
82
+ *
83
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
84
+ *
85
+ * @throws {@link DataSourceNotFoundException} (client fault)
86
+ *
87
+ * @throws {@link DocumentNotFoundException} (client fault)
88
+ *
89
+ * @throws {@link KnowledgeBaseServiceException}
90
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
91
+ *
92
+ *
93
+ * @public
94
+ */
95
+ export declare class CreateDocumentCommand extends CreateDocumentCommand_base {
96
+ /** @internal type navigation helper, not in runtime. */
97
+ protected static __types: {
98
+ api: {
99
+ input: CreateDocumentInput;
100
+ output: CreateDocumentOutput;
101
+ };
102
+ sdk: {
103
+ input: CreateDocumentCommandInput;
104
+ output: CreateDocumentCommandOutput;
105
+ };
106
+ };
107
+ }
@@ -0,0 +1,99 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { CreateKnowledgeBaseInput, CreateKnowledgeBaseOutput } 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 CreateKnowledgeBaseCommand}.
14
+ */
15
+ export interface CreateKnowledgeBaseCommandInput extends CreateKnowledgeBaseInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateKnowledgeBaseCommand}.
21
+ */
22
+ export interface CreateKnowledgeBaseCommandOutput extends CreateKnowledgeBaseOutput, __MetadataBearer {
23
+ }
24
+ declare const CreateKnowledgeBaseCommand_base: {
25
+ new (input: CreateKnowledgeBaseCommandInput): import("@smithy/smithy-client").CommandImpl<CreateKnowledgeBaseCommandInput, CreateKnowledgeBaseCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateKnowledgeBaseCommandInput): import("@smithy/smithy-client").CommandImpl<CreateKnowledgeBaseCommandInput, CreateKnowledgeBaseCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Create a new knowledge base
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KnowledgeBaseClient, CreateKnowledgeBaseCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, CreateKnowledgeBaseCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // CreateKnowledgeBaseInput
38
+ * name: "STRING_VALUE", // required
39
+ * description: "STRING_VALUE",
40
+ * dataSources: [ // DataSourceIdsList // required
41
+ * "STRING_VALUE",
42
+ * ],
43
+ * companyId: "STRING_VALUE",
44
+ * };
45
+ * const command = new CreateKnowledgeBaseCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // CreateKnowledgeBaseOutput
48
+ * // knowledgeBase: { // KnowledgeBaseItem
49
+ * // name: "STRING_VALUE", // required
50
+ * // description: "STRING_VALUE",
51
+ * // dataSources: [ // DataSourceIdsList // required
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // id: "STRING_VALUE", // required
55
+ * // companyId: "STRING_VALUE", // required
56
+ * // createdAt: "STRING_VALUE", // required
57
+ * // updatedAt: "STRING_VALUE", // required
58
+ * // },
59
+ * // };
60
+ *
61
+ * ```
62
+ *
63
+ * @param CreateKnowledgeBaseCommandInput - {@link CreateKnowledgeBaseCommandInput}
64
+ * @returns {@link CreateKnowledgeBaseCommandOutput}
65
+ * @see {@link CreateKnowledgeBaseCommandInput} for command's `input` shape.
66
+ * @see {@link CreateKnowledgeBaseCommandOutput} for command's `response` shape.
67
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
68
+ *
69
+ * @throws {@link ValidationException} (client fault)
70
+ *
71
+ * @throws {@link UnauthorizedException} (client fault)
72
+ *
73
+ * @throws {@link ForbiddenException} (client fault)
74
+ *
75
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
76
+ *
77
+ * @throws {@link DataSourceNotFoundException} (client fault)
78
+ *
79
+ * @throws {@link DocumentNotFoundException} (client fault)
80
+ *
81
+ * @throws {@link KnowledgeBaseServiceException}
82
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
83
+ *
84
+ *
85
+ * @public
86
+ */
87
+ export declare class CreateKnowledgeBaseCommand extends CreateKnowledgeBaseCommand_base {
88
+ /** @internal type navigation helper, not in runtime. */
89
+ protected static __types: {
90
+ api: {
91
+ input: CreateKnowledgeBaseInput;
92
+ output: CreateKnowledgeBaseOutput;
93
+ };
94
+ sdk: {
95
+ input: CreateKnowledgeBaseCommandInput;
96
+ output: CreateKnowledgeBaseCommandOutput;
97
+ };
98
+ };
99
+ }
@@ -0,0 +1,83 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { DeleteDataSourceInput, DeleteDataSourceOutput } 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 DeleteDataSourceCommand}.
14
+ */
15
+ export interface DeleteDataSourceCommandInput extends DeleteDataSourceInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteDataSourceCommand}.
21
+ */
22
+ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceOutput, __MetadataBearer {
23
+ }
24
+ declare const DeleteDataSourceCommand_base: {
25
+ new (input: DeleteDataSourceCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteDataSourceCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Delete 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, DeleteDataSourceCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, DeleteDataSourceCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // DeleteDataSourceInput
38
+ * companyId: "STRING_VALUE",
39
+ * dataSourceId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new DeleteDataSourceCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param DeleteDataSourceCommandInput - {@link DeleteDataSourceCommandInput}
48
+ * @returns {@link DeleteDataSourceCommandOutput}
49
+ * @see {@link DeleteDataSourceCommandInput} for command's `input` shape.
50
+ * @see {@link DeleteDataSourceCommandOutput} for command's `response` shape.
51
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
52
+ *
53
+ * @throws {@link DataSourceNotFoundException} (client fault)
54
+ *
55
+ * @throws {@link UnauthorizedException} (client fault)
56
+ *
57
+ * @throws {@link ForbiddenException} (client fault)
58
+ *
59
+ * @throws {@link ValidationException} (client fault)
60
+ *
61
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
62
+ *
63
+ * @throws {@link DocumentNotFoundException} (client fault)
64
+ *
65
+ * @throws {@link KnowledgeBaseServiceException}
66
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
67
+ *
68
+ *
69
+ * @public
70
+ */
71
+ export declare class DeleteDataSourceCommand extends DeleteDataSourceCommand_base {
72
+ /** @internal type navigation helper, not in runtime. */
73
+ protected static __types: {
74
+ api: {
75
+ input: DeleteDataSourceInput;
76
+ output: {};
77
+ };
78
+ sdk: {
79
+ input: DeleteDataSourceCommandInput;
80
+ output: DeleteDataSourceCommandOutput;
81
+ };
82
+ };
83
+ }
@@ -0,0 +1,84 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { DeleteDocumentInput, DeleteDocumentOutput } 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 DeleteDocumentCommand}.
14
+ */
15
+ export interface DeleteDocumentCommandInput extends DeleteDocumentInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteDocumentCommand}.
21
+ */
22
+ export interface DeleteDocumentCommandOutput extends DeleteDocumentOutput, __MetadataBearer {
23
+ }
24
+ declare const DeleteDocumentCommand_base: {
25
+ new (input: DeleteDocumentCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDocumentCommandInput, DeleteDocumentCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteDocumentCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteDocumentCommandInput, DeleteDocumentCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Delete 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, DeleteDocumentCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, DeleteDocumentCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // DeleteDocumentInput
38
+ * companyId: "STRING_VALUE",
39
+ * dataSourceId: "STRING_VALUE", // required
40
+ * documentId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new DeleteDocumentCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param DeleteDocumentCommandInput - {@link DeleteDocumentCommandInput}
49
+ * @returns {@link DeleteDocumentCommandOutput}
50
+ * @see {@link DeleteDocumentCommandInput} for command's `input` shape.
51
+ * @see {@link DeleteDocumentCommandOutput} for command's `response` shape.
52
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
53
+ *
54
+ * @throws {@link DocumentNotFoundException} (client fault)
55
+ *
56
+ * @throws {@link UnauthorizedException} (client fault)
57
+ *
58
+ * @throws {@link ForbiddenException} (client fault)
59
+ *
60
+ * @throws {@link ValidationException} (client fault)
61
+ *
62
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
63
+ *
64
+ * @throws {@link DataSourceNotFoundException} (client fault)
65
+ *
66
+ * @throws {@link KnowledgeBaseServiceException}
67
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
68
+ *
69
+ *
70
+ * @public
71
+ */
72
+ export declare class DeleteDocumentCommand extends DeleteDocumentCommand_base {
73
+ /** @internal type navigation helper, not in runtime. */
74
+ protected static __types: {
75
+ api: {
76
+ input: DeleteDocumentInput;
77
+ output: {};
78
+ };
79
+ sdk: {
80
+ input: DeleteDocumentCommandInput;
81
+ output: DeleteDocumentCommandOutput;
82
+ };
83
+ };
84
+ }
@@ -0,0 +1,83 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { DeleteKnowledgeBaseInput, DeleteKnowledgeBaseOutput } 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 DeleteKnowledgeBaseCommand}.
14
+ */
15
+ export interface DeleteKnowledgeBaseCommandInput extends DeleteKnowledgeBaseInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteKnowledgeBaseCommand}.
21
+ */
22
+ export interface DeleteKnowledgeBaseCommandOutput extends DeleteKnowledgeBaseOutput, __MetadataBearer {
23
+ }
24
+ declare const DeleteKnowledgeBaseCommand_base: {
25
+ new (input: DeleteKnowledgeBaseCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteKnowledgeBaseCommandInput, DeleteKnowledgeBaseCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteKnowledgeBaseCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteKnowledgeBaseCommandInput, DeleteKnowledgeBaseCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Delete 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, DeleteKnowledgeBaseCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, DeleteKnowledgeBaseCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // DeleteKnowledgeBaseInput
38
+ * companyId: "STRING_VALUE",
39
+ * knowledgeBaseId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new DeleteKnowledgeBaseCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param DeleteKnowledgeBaseCommandInput - {@link DeleteKnowledgeBaseCommandInput}
48
+ * @returns {@link DeleteKnowledgeBaseCommandOutput}
49
+ * @see {@link DeleteKnowledgeBaseCommandInput} for command's `input` shape.
50
+ * @see {@link DeleteKnowledgeBaseCommandOutput} for command's `response` shape.
51
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
52
+ *
53
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
54
+ *
55
+ * @throws {@link UnauthorizedException} (client fault)
56
+ *
57
+ * @throws {@link ForbiddenException} (client fault)
58
+ *
59
+ * @throws {@link ValidationException} (client fault)
60
+ *
61
+ * @throws {@link DataSourceNotFoundException} (client fault)
62
+ *
63
+ * @throws {@link DocumentNotFoundException} (client fault)
64
+ *
65
+ * @throws {@link KnowledgeBaseServiceException}
66
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
67
+ *
68
+ *
69
+ * @public
70
+ */
71
+ export declare class DeleteKnowledgeBaseCommand extends DeleteKnowledgeBaseCommand_base {
72
+ /** @internal type navigation helper, not in runtime. */
73
+ protected static __types: {
74
+ api: {
75
+ input: DeleteKnowledgeBaseInput;
76
+ output: {};
77
+ };
78
+ sdk: {
79
+ input: DeleteKnowledgeBaseCommandInput;
80
+ output: DeleteKnowledgeBaseCommandOutput;
81
+ };
82
+ };
83
+ }
@@ -0,0 +1,85 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { GetAuthorizationSessionForDataSourceInput, GetAuthorizationSessionForDataSourceOutput } 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 GetAuthorizationSessionForDataSourceCommand}.
14
+ */
15
+ export interface GetAuthorizationSessionForDataSourceCommandInput extends GetAuthorizationSessionForDataSourceInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetAuthorizationSessionForDataSourceCommand}.
21
+ */
22
+ export interface GetAuthorizationSessionForDataSourceCommandOutput extends GetAuthorizationSessionForDataSourceOutput, __MetadataBearer {
23
+ }
24
+ declare const GetAuthorizationSessionForDataSourceCommand_base: {
25
+ new (input: GetAuthorizationSessionForDataSourceCommandInput): import("@smithy/smithy-client").CommandImpl<GetAuthorizationSessionForDataSourceCommandInput, GetAuthorizationSessionForDataSourceCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetAuthorizationSessionForDataSourceCommandInput): import("@smithy/smithy-client").CommandImpl<GetAuthorizationSessionForDataSourceCommandInput, GetAuthorizationSessionForDataSourceCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Get a Nango authorization session for a data source
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { KnowledgeBaseClient, GetAuthorizationSessionForDataSourceCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, GetAuthorizationSessionForDataSourceCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // GetAuthorizationSessionForDataSourceInput
38
+ * companyId: "STRING_VALUE",
39
+ * dataSourceId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetAuthorizationSessionForDataSourceCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetAuthorizationSessionForDataSourceOutput
44
+ * // authorizationSession: "STRING_VALUE", // required
45
+ * // };
46
+ *
47
+ * ```
48
+ *
49
+ * @param GetAuthorizationSessionForDataSourceCommandInput - {@link GetAuthorizationSessionForDataSourceCommandInput}
50
+ * @returns {@link GetAuthorizationSessionForDataSourceCommandOutput}
51
+ * @see {@link GetAuthorizationSessionForDataSourceCommandInput} for command's `input` shape.
52
+ * @see {@link GetAuthorizationSessionForDataSourceCommandOutput} for command's `response` shape.
53
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
54
+ *
55
+ * @throws {@link DataSourceNotFoundException} (client fault)
56
+ *
57
+ * @throws {@link UnauthorizedException} (client fault)
58
+ *
59
+ * @throws {@link ForbiddenException} (client fault)
60
+ *
61
+ * @throws {@link ValidationException} (client fault)
62
+ *
63
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
64
+ *
65
+ * @throws {@link DocumentNotFoundException} (client fault)
66
+ *
67
+ * @throws {@link KnowledgeBaseServiceException}
68
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
69
+ *
70
+ *
71
+ * @public
72
+ */
73
+ export declare class GetAuthorizationSessionForDataSourceCommand extends GetAuthorizationSessionForDataSourceCommand_base {
74
+ /** @internal type navigation helper, not in runtime. */
75
+ protected static __types: {
76
+ api: {
77
+ input: GetAuthorizationSessionForDataSourceInput;
78
+ output: GetAuthorizationSessionForDataSourceOutput;
79
+ };
80
+ sdk: {
81
+ input: GetAuthorizationSessionForDataSourceCommandInput;
82
+ output: GetAuthorizationSessionForDataSourceCommandOutput;
83
+ };
84
+ };
85
+ }
@@ -0,0 +1,131 @@
1
+ import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
2
+ import { GetDataSourceInput, GetDataSourceOutput } 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 GetDataSourceCommand}.
14
+ */
15
+ export interface GetDataSourceCommandInput extends GetDataSourceInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetDataSourceCommand}.
21
+ */
22
+ export interface GetDataSourceCommandOutput extends GetDataSourceOutput, __MetadataBearer {
23
+ }
24
+ declare const GetDataSourceCommand_base: {
25
+ new (input: GetDataSourceCommandInput): import("@smithy/smithy-client").CommandImpl<GetDataSourceCommandInput, GetDataSourceCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetDataSourceCommandInput): import("@smithy/smithy-client").CommandImpl<GetDataSourceCommandInput, GetDataSourceCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Get 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, GetDataSourceCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
35
+ * // const { KnowledgeBaseClient, GetDataSourceCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
+ * const client = new KnowledgeBaseClient(config);
37
+ * const input = { // GetDataSourceInput
38
+ * companyId: "STRING_VALUE",
39
+ * dataSourceId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetDataSourceCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetDataSourceOutput
44
+ * // dataSource: { // DataSourceItem
45
+ * // name: "STRING_VALUE", // required
46
+ * // description: "STRING_VALUE",
47
+ * // type: "files" || "confluence" || "gdrive" || "proxy", // required
48
+ * // config: { // DataSourceConfig Union: only one key present
49
+ * // confluence: { // ConfluenceConfig
50
+ * // url: "STRING_VALUE", // required
51
+ * // username: "STRING_VALUE", // required
52
+ * // apiKey: "STRING_VALUE", // required
53
+ * // spaceId: "STRING_VALUE", // required
54
+ * // pages: { // ConfluencePagesConfig
55
+ * // enabled: [ // ConfluencePageIdsList // required
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // disabled: [ // required
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // },
62
+ * // },
63
+ * // gdrive: { // GDriveConfig
64
+ * // nangoConnectionId: "STRING_VALUE", // required
65
+ * // folders: { // GDriveFoldersConfig
66
+ * // enabled: [ // GDriveFolderIds // required
67
+ * // "STRING_VALUE",
68
+ * // ],
69
+ * // disabled: [ // required
70
+ * // "STRING_VALUE",
71
+ * // ],
72
+ * // },
73
+ * // },
74
+ * // files: { // UserFilesConfig
75
+ * // allowedExtensions: [ // StringList // required
76
+ * // "STRING_VALUE",
77
+ * // ],
78
+ * // },
79
+ * // },
80
+ * // enabled: true || false, // required
81
+ * // syncSchedule: "STRING_VALUE",
82
+ * // id: "STRING_VALUE", // required
83
+ * // companyId: "STRING_VALUE", // required
84
+ * // createdAt: "STRING_VALUE", // required
85
+ * // updatedAt: "STRING_VALUE", // required
86
+ * // syncStatus: "idle" || "running" || "success" || "failed", // required
87
+ * // lastSyncedAt: "STRING_VALUE",
88
+ * // lastSyncMode: "full" || "incremental" || "unknown",
89
+ * // lastSyncErrorMessage: "STRING_VALUE",
90
+ * // },
91
+ * // };
92
+ *
93
+ * ```
94
+ *
95
+ * @param GetDataSourceCommandInput - {@link GetDataSourceCommandInput}
96
+ * @returns {@link GetDataSourceCommandOutput}
97
+ * @see {@link GetDataSourceCommandInput} for command's `input` shape.
98
+ * @see {@link GetDataSourceCommandOutput} for command's `response` shape.
99
+ * @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
100
+ *
101
+ * @throws {@link DataSourceNotFoundException} (client fault)
102
+ *
103
+ * @throws {@link UnauthorizedException} (client fault)
104
+ *
105
+ * @throws {@link ForbiddenException} (client fault)
106
+ *
107
+ * @throws {@link ValidationException} (client fault)
108
+ *
109
+ * @throws {@link KnowledgeBaseNotFoundException} (client fault)
110
+ *
111
+ * @throws {@link DocumentNotFoundException} (client fault)
112
+ *
113
+ * @throws {@link KnowledgeBaseServiceException}
114
+ * <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
115
+ *
116
+ *
117
+ * @public
118
+ */
119
+ export declare class GetDataSourceCommand extends GetDataSourceCommand_base {
120
+ /** @internal type navigation helper, not in runtime. */
121
+ protected static __types: {
122
+ api: {
123
+ input: GetDataSourceInput;
124
+ output: GetDataSourceOutput;
125
+ };
126
+ sdk: {
127
+ input: GetDataSourceCommandInput;
128
+ output: GetDataSourceCommandOutput;
129
+ };
130
+ };
131
+ }