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

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.
@@ -441,6 +441,8 @@ const se_ListDocumentsCommand = async (input, context) => {
441
441
  [_o]: [() => input.offset !== void 0, () => (input[_o].toString())],
442
442
  [_s]: [, input[_s]],
443
443
  [_se]: [, input[_se]],
444
+ [_oI]: [, input[_oI]],
445
+ [_st]: [, input[_st]],
444
446
  });
445
447
  let body;
446
448
  b.m("GET")
@@ -607,10 +609,8 @@ const se_UpdateDocumentCommand = async (input, context) => {
607
609
  body = JSON.stringify((0, smithy_client_1.take)(input, {
608
610
  'content': [],
609
611
  'description': [],
610
- 'originalFormat': [],
611
- 'originalId': [],
612
- 'originalName': [],
613
612
  'title': [],
613
+ 'updatedAt': [],
614
614
  'url': [],
615
615
  }));
616
616
  b.m("PUT")
@@ -1412,6 +1412,8 @@ const _cI = "companyId";
1412
1412
  const _l = "limit";
1413
1413
  const _lL = "logLevel";
1414
1414
  const _o = "offset";
1415
+ const _oI = "originalId";
1415
1416
  const _s = "sort";
1416
1417
  const _sT = "syncType";
1417
1418
  const _se = "search";
1419
+ const _st = "status";
@@ -414,6 +414,8 @@ export const se_ListDocumentsCommand = async (input, context) => {
414
414
  [_o]: [() => input.offset !== void 0, () => (input[_o].toString())],
415
415
  [_s]: [, input[_s]],
416
416
  [_se]: [, input[_se]],
417
+ [_oI]: [, input[_oI]],
418
+ [_st]: [, input[_st]],
417
419
  });
418
420
  let body;
419
421
  b.m("GET")
@@ -572,10 +574,8 @@ export const se_UpdateDocumentCommand = async (input, context) => {
572
574
  body = JSON.stringify(take(input, {
573
575
  'content': [],
574
576
  'description': [],
575
- 'originalFormat': [],
576
- 'originalId': [],
577
- 'originalName': [],
578
577
  'title': [],
578
+ 'updatedAt': [],
579
579
  'url': [],
580
580
  }));
581
581
  b.m("PUT")
@@ -1342,6 +1342,8 @@ const _cI = "companyId";
1342
1342
  const _l = "limit";
1343
1343
  const _lL = "logLevel";
1344
1344
  const _o = "offset";
1345
+ const _oI = "originalId";
1345
1346
  const _s = "sort";
1346
1347
  const _sT = "syncType";
1347
1348
  const _se = "search";
1349
+ const _st = "status";
@@ -41,6 +41,8 @@ declare const ListDocumentsCommand_base: {
41
41
  * sort: "STRING_VALUE",
42
42
  * dataSourceId: "STRING_VALUE", // required
43
43
  * search: "STRING_VALUE",
44
+ * originalId: "STRING_VALUE",
45
+ * status: "draft" || "pending" || "processing" || "completed" || "failed",
44
46
  * };
45
47
  * const command = new ListDocumentsCommand(input);
46
48
  * const response = await client.send(command);
@@ -35,13 +35,11 @@ declare const UpdateDocumentCommand_base: {
35
35
  * // const { KnowledgeBaseClient, UpdateDocumentCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
36
36
  * const client = new KnowledgeBaseClient(config);
37
37
  * const input = { // UpdateDocumentInput
38
- * title: "STRING_VALUE", // required
38
+ * title: "STRING_VALUE",
39
39
  * url: "STRING_VALUE",
40
- * content: "STRING_VALUE",
41
40
  * description: "STRING_VALUE",
42
- * originalFormat: "STRING_VALUE", // required
43
- * originalName: "STRING_VALUE", // required
44
- * originalId: "STRING_VALUE",
41
+ * content: "STRING_VALUE",
42
+ * updatedAt: "STRING_VALUE",
45
43
  * companyId: "STRING_VALUE",
46
44
  * dataSourceId: "STRING_VALUE", // required
47
45
  * documentId: "STRING_VALUE", // required
@@ -447,7 +447,7 @@ export interface CreateDocumentInput {
447
447
  */
448
448
  dataSourceId: string;
449
449
  /**
450
- * Additional metadata of the document. Example: \{ 'createdAt': '2025-01-01T00:00:00Z', 'updatedAt': '2025-05-01T00:00:00Z', 'createdBy': 'user@example.com' \}
450
+ * Additional metadata of the document. Example: `\{ 'createdAt': '2025-01-01T00:00:00Z', 'updatedAt': '2025-05-01T00:00:00Z', 'createdBy': 'user@example.com' \}`
451
451
  * @public
452
452
  */
453
453
  metadata?: __DocumentType | undefined;
@@ -1544,6 +1544,16 @@ export interface ListDocumentsInput {
1544
1544
  * @public
1545
1545
  */
1546
1546
  search?: string | undefined;
1547
+ /**
1548
+ * Original ID from the source system, preserving the reference to the source document.
1549
+ * @public
1550
+ */
1551
+ originalId?: string | undefined;
1552
+ /**
1553
+ * Status of the document.
1554
+ * @public
1555
+ */
1556
+ status?: DocumentStatus | undefined;
1547
1557
  }
1548
1558
  /**
1549
1559
  * @public
@@ -1605,7 +1615,7 @@ export interface SearchHistoryFilter {
1605
1615
  */
1606
1616
  sessionId?: string | undefined;
1607
1617
  /**
1608
- * Filter history by the session URI. Used for tracking and analytics purposes. Example: chatbots://\{agentId\}/id-of-chat-session/id-of-message
1618
+ * Filter history by the session URI. Used for tracking and analytics purposes. Example: `chatbots://\{agentId\}/id-of-chat-session/id-of-message`
1609
1619
  * @public
1610
1620
  */
1611
1621
  sessionUri?: string | undefined;
@@ -1860,7 +1870,7 @@ export interface SearchKnowledgeBaseInput {
1860
1870
  */
1861
1871
  sessionUser?: string | undefined;
1862
1872
  /**
1863
- * The session URI. Used for tracking and analytics purposes. Example: chatbots://\{agentId\}/id-of-chat-session/id-of-message
1873
+ * The session URI. Used for tracking and analytics purposes. Example: `chatbots://\{agentId\}/id-of-chat-session/id-of-message`
1864
1874
  * @public
1865
1875
  */
1866
1876
  sessionUri?: string | undefined;
@@ -1963,37 +1973,27 @@ export interface UpdateDocumentInput {
1963
1973
  * Display title of the document used in search results and UI. Can differ from originalName. Examples: 'Product Installation Guide', 'API Documentation'. Length: 2-100 characters
1964
1974
  * @public
1965
1975
  */
1966
- title: string;
1976
+ title?: string | undefined;
1967
1977
  /**
1968
1978
  * Optional URL where the document can be accessed or viewed. Used for providing direct links to the source. Example: https://confluence.company.com/wiki/Product_Documentation
1969
1979
  * @public
1970
1980
  */
1971
1981
  url?: string | undefined;
1972
- /**
1973
- * Optional document content in plain text or markdown format. For file uploads, can be the document content.
1974
- * @public
1975
- */
1976
- content?: string | undefined;
1977
1982
  /**
1978
1983
  * Optional detailed description of the document content and purpose. Helps users understand what the document is about.
1979
1984
  * @public
1980
1985
  */
1981
1986
  description?: string | undefined;
1982
1987
  /**
1983
- * File format/extension of the original document for reference. Examples: 'pdf', 'docx', 'md', 'html', 'txt'. Helps identify source document type
1984
- * @public
1985
- */
1986
- originalFormat: string;
1987
- /**
1988
- * Original filename or identifier of the source document. Preserves the source document name. Examples: 'product-knowledge-base.pdf', 'installation-guide.docx'
1988
+ * Optional document content in plain text or markdown format. For file uploads, can be the document content.
1989
1989
  * @public
1990
1990
  */
1991
- originalName: string;
1991
+ content?: string | undefined;
1992
1992
  /**
1993
- * Original ID from the source system, preserving the reference to the source document. Examples: 'confluence-page-1234567890' (for Confluence), 'gdrive-file-abc123' (for Google Drive), sha1(original-file-content) (for file uploads)
1993
+ * Timestamp when the document was last updated (ISO 8601 format). Example: 2021-01-01T00:00:00Z
1994
1994
  * @public
1995
1995
  */
1996
- originalId?: string | undefined;
1996
+ updatedAt?: string | undefined;
1997
1997
  /**
1998
1998
  * The unique identifier of the tenant when a service token is used.
1999
1999
  * @public
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@wildix/wim-knowledge-base-client",
3
3
  "description": "@wildix/wim-knowledge-base-client client",
4
- "version": "0.1.3",
4
+ "version": "0.1.5",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",