@wildix/wim-knowledge-base-client 0.1.1 → 0.1.3

package/dist-cjs/protocols/Aws_restJson1.js

@@ -96,6 +96,7 @@ const se_CreateDocumentCommand = async (input, context) => {
     let body;
     body = JSON.stringify((0, smithy_client_1.take)(input, {
         'content': [],
+        'description': [],
         'metadata': _ => se_Document(_, context),
         'originalFormat': [],
         'originalId': [],
@@ -605,6 +606,7 @@ const se_UpdateDocumentCommand = async (input, context) => {
     let body;
     body = JSON.stringify((0, smithy_client_1.take)(input, {
         'content': [],
+        'description': [],
         'originalFormat': [],
         'originalId': [],
         'originalName': [],
@@ -974,6 +976,7 @@ const de_ListDataSourceSynchronizationLogsCommand = async (output, context) => {
     const data = (0, smithy_client_1.expectNonNull)(((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context))), "body");
     const doc = (0, smithy_client_1.take)(data, {
         'logs': smithy_client_1._json,
+        'metadata': smithy_client_1._json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -989,6 +992,7 @@ const de_ListDocumentsCommand = async (output, context) => {
     const data = (0, smithy_client_1.expectNonNull)(((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context))), "body");
     const doc = (0, smithy_client_1.take)(data, {
         'documents': smithy_client_1._json,
+        'metadata': smithy_client_1._json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -1034,6 +1038,7 @@ const de_ListSearchQueriesHistoryCommand = async (output, context) => {
     const data = (0, smithy_client_1.expectNonNull)(((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context))), "body");
     const doc = (0, smithy_client_1.take)(data, {
         'history': _ => de_SearchHistoryList(_, context),
+        'metadata': smithy_client_1._json,
     });
     Object.assign(contents, doc);
     return contents;

package/dist-es/protocols/Aws_restJson1.js

@@ -88,6 +88,7 @@ export const se_CreateDocumentCommand = async (input, context) => {
     let body;
     body = JSON.stringify(take(input, {
         'content': [],
+        'description': [],
         'metadata': _ => se_Document(_, context),
         'originalFormat': [],
         'originalId': [],
@@ -570,6 +571,7 @@ export const se_UpdateDocumentCommand = async (input, context) => {
     let body;
     body = JSON.stringify(take(input, {
         'content': [],
+        'description': [],
         'originalFormat': [],
         'originalId': [],
         'originalName': [],
@@ -915,6 +917,7 @@ export const de_ListDataSourceSynchronizationLogsCommand = async (output, contex
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
         'logs': _json,
+        'metadata': _json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -929,6 +932,7 @@ export const de_ListDocumentsCommand = async (output, context) => {
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
         'documents': _json,
+        'metadata': _json,
     });
     Object.assign(contents, doc);
     return contents;
@@ -971,6 +975,7 @@ export const de_ListSearchQueriesHistoryCommand = async (output, context) => {
     const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
     const doc = take(data, {
         'history': _ => de_SearchHistoryList(_, context),
+        'metadata': _json,
     });
     Object.assign(contents, doc);
     return contents;

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

@@ -38,6 +38,7 @@ declare const CreateDocumentCommand_base: {
  *   title: "STRING_VALUE", // required
  *   url: "STRING_VALUE",
  *   content: "STRING_VALUE",
+ *   description: "STRING_VALUE",
  *   originalFormat: "STRING_VALUE", // required
  *   originalName: "STRING_VALUE", // required
  *   originalId: "STRING_VALUE",
@@ -52,6 +53,7 @@ declare const CreateDocumentCommand_base: {
  * //     title: "STRING_VALUE", // required
  * //     url: "STRING_VALUE",
  * //     content: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
  * //     originalFormat: "STRING_VALUE", // required
  * //     originalName: "STRING_VALUE", // required
  * //     originalId: "STRING_VALUE",

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

@@ -46,6 +46,7 @@ declare const GetDocumentCommand_base: {
  * //     title: "STRING_VALUE", // required
  * //     url: "STRING_VALUE",
  * //     content: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
  * //     originalFormat: "STRING_VALUE", // required
  * //     originalName: "STRING_VALUE", // required
  * //     originalId: "STRING_VALUE",

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

@@ -46,6 +46,7 @@ declare const GetDocumentWithContentAndChunksCommand_base: {
  * //     title: "STRING_VALUE", // required
  * //     url: "STRING_VALUE",
  * //     content: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
  * //     originalFormat: "STRING_VALUE", // required
  * //     originalName: "STRING_VALUE", // required
  * //     originalId: "STRING_VALUE",

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

@@ -53,6 +53,11 @@ declare const ListDataSourceSynchronizationLogsCommand_base: {
  * //       message: "STRING_VALUE", // required
  * //     },
  * //   ],
+ * //   metadata: { // PaginationMetadata
+ * //     total: Number("int"), // required
+ * //     limit: Number("int"),
+ * //     offset: Number("int"),
+ * //   },
  * // };
  *
  * ```

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

@@ -50,6 +50,7 @@ declare const ListDocumentsCommand_base: {
  * //       title: "STRING_VALUE", // required
  * //       url: "STRING_VALUE",
  * //       content: "STRING_VALUE",
+ * //       description: "STRING_VALUE",
  * //       originalFormat: "STRING_VALUE", // required
  * //       originalName: "STRING_VALUE", // required
  * //       originalId: "STRING_VALUE",
@@ -65,6 +66,11 @@ declare const ListDocumentsCommand_base: {
  * //       errorMessage: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   metadata: { // PaginationMetadata
+ * //     total: Number("int"), // required
+ * //     limit: Number("int"),
+ * //     offset: Number("int"),
+ * //   },
  * // };
  *
  * ```

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

@@ -122,6 +122,11 @@ declare const ListSearchQueriesHistoryCommand_base: {
  * //       resultsCount: Number("int"), // required
  * //     },
  * //   ],
+ * //   metadata: { // PaginationMetadata
+ * //     total: Number("int"), // required
+ * //     limit: Number("int"),
+ * //     offset: Number("int"),
+ * //   },
  * // };
  *
  * ```

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

@@ -38,6 +38,7 @@ declare const UpdateDocumentCommand_base: {
  *   title: "STRING_VALUE", // required
  *   url: "STRING_VALUE",
  *   content: "STRING_VALUE",
+ *   description: "STRING_VALUE",
  *   originalFormat: "STRING_VALUE", // required
  *   originalName: "STRING_VALUE", // required
  *   originalId: "STRING_VALUE",
@@ -52,6 +53,7 @@ declare const UpdateDocumentCommand_base: {
  * //     title: "STRING_VALUE", // required
  * //     url: "STRING_VALUE",
  * //     content: "STRING_VALUE",
+ * //     description: "STRING_VALUE",
  * //     originalFormat: "STRING_VALUE", // required
  * //     originalName: "STRING_VALUE", // required
  * //     originalId: "STRING_VALUE",

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

@@ -416,6 +416,11 @@ export interface CreateDocumentInput {
      * @public
      */
     content?: string | undefined;
+    /**
+     * Optional detailed description of the document content and purpose. Helps users understand what the document is about.
+     * @public
+     */
+    description?: string | undefined;
     /**
      * File format/extension of the original document for reference. Examples: 'pdf', 'docx', 'md', 'html', 'txt'. Helps identify source document type
      * @public
@@ -481,6 +486,11 @@ export interface DocumentItem {
      * @public
      */
     content?: string | undefined;
+    /**
+     * Optional detailed description of the document content and purpose. Helps users understand what the document is about.
+     * @public
+     */
+    description?: string | undefined;
     /**
      * File format/extension of the original document for reference. Examples: 'pdf', 'docx', 'md', 'html', 'txt'. Helps identify source document type
      * @public
@@ -1481,11 +1491,32 @@ export interface SyncLogItem {
     level: SyncLogLevel;
     message: string;
 }
+/**
+ * @public
+ */
+export interface PaginationMetadata {
+    /**
+     * The total number of results.
+     * @public
+     */
+    total: number;
+    /**
+     * The number of results per page.
+     * @public
+     */
+    limit?: number | undefined;
+    /**
+     * The offset from which to start the results.
+     * @public
+     */
+    offset?: number | undefined;
+}
 /**
  * @public
  */
 export interface ListDataSourceSynchronizationLogsOutput {
     logs: (SyncLogItem)[];
+    metadata: PaginationMetadata;
 }
 /**
  * @public
@@ -1519,6 +1550,7 @@ export interface ListDocumentsInput {
  */
 export interface ListDocumentsOutput {
     documents: (DocumentItem)[];
+    metadata: PaginationMetadata;
 }
 /**
  * @public
@@ -1768,6 +1800,7 @@ export interface SearchHistoryItem {
  */
 export interface ListSearchQueriesHistoryOutput {
     history: (SearchHistoryItem)[];
+    metadata: PaginationMetadata;
 }
 /**
  * @public
@@ -1941,6 +1974,11 @@ export interface UpdateDocumentInput {
      * @public
      */
     content?: string | undefined;
+    /**
+     * Optional detailed description of the document content and purpose. Helps users understand what the document is about.
+     * @public
+     */
+    description?: string | undefined;
     /**
      * File format/extension of the original document for reference. Examples: 'pdf', 'docx', 'md', 'html', 'txt'. Helps identify source document type
      * @public

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/wim-knowledge-base-client",
     "description": "@wildix/wim-knowledge-base-client client",
-    "version": "0.1.1",
+    "version": "0.1.3",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",