@wildix/wim-knowledge-base-client 0.1.4 → 0.1.6

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.
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SearchThresholdValue = exports.SearchStrategy = exports.SyncLogLevel = exports.SyncDataSourceStatus = exports.SyncDataSourceMode = exports.DocumentStatus = exports.DataSourceType = exports.ScheduleConfiguration = exports.DataSourceConfig = exports.KnowledgeBaseNotFoundException = exports.DocumentNotFoundException = exports.DataSourceNotFoundException = exports.ValidationException = exports.UnauthorizedException = exports.ForbiddenException = void 0;
3
+ exports.SearchThresholdValue = exports.SearchStrategy = exports.SyncLogLevel = exports.SyncDataSourceStatus = exports.SyncDataSourceMode = exports.DescribeDataSourceConfluenceSpaceType = exports.DocumentStatus = exports.DataSourceType = exports.ScheduleConfiguration = exports.DataSourceConfig = exports.KnowledgeBaseNotFoundException = exports.DocumentNotFoundException = exports.DataSourceNotFoundException = exports.ValidationException = exports.UnauthorizedException = exports.ForbiddenException = void 0;
4
4
  const KnowledgeBaseServiceException_1 = require("./KnowledgeBaseServiceException");
5
5
  class ForbiddenException extends KnowledgeBaseServiceException_1.KnowledgeBaseServiceException {
6
6
  name = "ForbiddenException";
@@ -111,6 +111,14 @@ exports.DocumentStatus = {
111
111
  PENDING: "pending",
112
112
  PROCESSING: "processing",
113
113
  };
114
+ exports.DescribeDataSourceConfluenceSpaceType = {
115
+ COLLABORATION: "collaboration",
116
+ GLOBAL: "global",
117
+ KNOWLEDGE_BASE: "knowledge_base",
118
+ ONBOARDING: "onboarding",
119
+ PERSONAL: "personal",
120
+ SYSTEM: "system",
121
+ };
114
122
  exports.SyncDataSourceMode = {
115
123
  FULL: "full",
116
124
  INCREMENTAL: "incremental",
@@ -609,10 +609,8 @@ const se_UpdateDocumentCommand = async (input, context) => {
609
609
  body = JSON.stringify((0, smithy_client_1.take)(input, {
610
610
  'content': [],
611
611
  'description': [],
612
- 'originalFormat': [],
613
- 'originalId': [],
614
- 'originalName': [],
615
612
  'title': [],
613
+ 'updatedAt': [],
616
614
  'url': [],
617
615
  }));
618
616
  b.m("PUT")
@@ -102,6 +102,14 @@ export const DocumentStatus = {
102
102
  PENDING: "pending",
103
103
  PROCESSING: "processing",
104
104
  };
105
+ export const DescribeDataSourceConfluenceSpaceType = {
106
+ COLLABORATION: "collaboration",
107
+ GLOBAL: "global",
108
+ KNOWLEDGE_BASE: "knowledge_base",
109
+ ONBOARDING: "onboarding",
110
+ PERSONAL: "personal",
111
+ SYSTEM: "system",
112
+ };
105
113
  export const SyncDataSourceMode = {
106
114
  FULL: "full",
107
115
  INCREMENTAL: "incremental",
@@ -574,10 +574,8 @@ export const se_UpdateDocumentCommand = async (input, context) => {
574
574
  body = JSON.stringify(take(input, {
575
575
  'content': [],
576
576
  'description': [],
577
- 'originalFormat': [],
578
- 'originalId': [],
579
- 'originalName': [],
580
577
  'title': [],
578
+ 'updatedAt': [],
581
579
  'url': [],
582
580
  }));
583
581
  b.m("PUT")
@@ -40,7 +40,7 @@ declare const DescribeDataSourceCommand_base: {
40
40
  * parameters: { // DescribeDataSourceParameters
41
41
  * confluence: { // DescribeDataSourceConfluenceParameters
42
42
  * spaces: { // DescribeDataSourceConfluenceSpacesParameters
43
- * type: "STRING_VALUE",
43
+ * type: "global" || "collaboration" || "knowledge_base" || "personal" || "system" || "onboarding",
44
44
  * },
45
45
  * pages: { // DescribeDataSourceConfluencePagesParameters
46
46
  * spaceId: "STRING_VALUE", // required
@@ -75,6 +75,7 @@ declare const DescribeDataSourceCommand_base: {
75
75
  * // id: "STRING_VALUE", // required
76
76
  * // name: "STRING_VALUE", // required
77
77
  * // key: "STRING_VALUE",
78
+ * // type: "global" || "collaboration" || "knowledge_base" || "personal" || "system" || "onboarding", // required
78
79
  * // },
79
80
  * // ],
80
81
  * // pages: [ // DescribeDataSourceConfluencePagesList
@@ -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
@@ -744,15 +744,31 @@ export interface DescribeDataSourceConfluencePagesParameters {
744
744
  */
745
745
  enabled?: (string)[] | undefined;
746
746
  }
747
+ /**
748
+ * @public
749
+ * @enum
750
+ */
751
+ export declare const DescribeDataSourceConfluenceSpaceType: {
752
+ readonly COLLABORATION: "collaboration";
753
+ readonly GLOBAL: "global";
754
+ readonly KNOWLEDGE_BASE: "knowledge_base";
755
+ readonly ONBOARDING: "onboarding";
756
+ readonly PERSONAL: "personal";
757
+ readonly SYSTEM: "system";
758
+ };
759
+ /**
760
+ * @public
761
+ */
762
+ export type DescribeDataSourceConfluenceSpaceType = typeof DescribeDataSourceConfluenceSpaceType[keyof typeof DescribeDataSourceConfluenceSpaceType];
747
763
  /**
748
764
  * @public
749
765
  */
750
766
  export interface DescribeDataSourceConfluenceSpacesParameters {
751
767
  /**
752
- * Filter spaces by type: 'global' (company-wide spaces) or 'personal' (individual user spaces). Defaults to 'global'
768
+ * Filter spaces by type.
753
769
  * @public
754
770
  */
755
- type?: string | undefined;
771
+ type?: DescribeDataSourceConfluenceSpaceType | undefined;
756
772
  }
757
773
  /**
758
774
  * @public
@@ -894,6 +910,11 @@ export interface DescribeDataSourceConfluenceSpaceResult {
894
910
  * @public
895
911
  */
896
912
  key?: string | undefined;
913
+ /**
914
+ * Type of the Confluence space
915
+ * @public
916
+ */
917
+ type: DescribeDataSourceConfluenceSpaceType;
897
918
  }
898
919
  /**
899
920
  * @public
@@ -1545,12 +1566,12 @@ export interface ListDocumentsInput {
1545
1566
  */
1546
1567
  search?: string | undefined;
1547
1568
  /**
1548
- * Original ID from the source system, preserving the reference to the source document.
1569
+ * Filter documents by original ID from the source system.
1549
1570
  * @public
1550
1571
  */
1551
1572
  originalId?: string | undefined;
1552
1573
  /**
1553
- * Status of the document.
1574
+ * Filter documents by status.
1554
1575
  * @public
1555
1576
  */
1556
1577
  status?: DocumentStatus | undefined;
@@ -1973,37 +1994,27 @@ export interface UpdateDocumentInput {
1973
1994
  * 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
1974
1995
  * @public
1975
1996
  */
1976
- title: string;
1997
+ title?: string | undefined;
1977
1998
  /**
1978
1999
  * 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
1979
2000
  * @public
1980
2001
  */
1981
2002
  url?: string | undefined;
1982
- /**
1983
- * Optional document content in plain text or markdown format. For file uploads, can be the document content.
1984
- * @public
1985
- */
1986
- content?: string | undefined;
1987
2003
  /**
1988
2004
  * Optional detailed description of the document content and purpose. Helps users understand what the document is about.
1989
2005
  * @public
1990
2006
  */
1991
2007
  description?: string | undefined;
1992
2008
  /**
1993
- * File format/extension of the original document for reference. Examples: 'pdf', 'docx', 'md', 'html', 'txt'. Helps identify source document type
1994
- * @public
1995
- */
1996
- originalFormat: string;
1997
- /**
1998
- * Original filename or identifier of the source document. Preserves the source document name. Examples: 'product-knowledge-base.pdf', 'installation-guide.docx'
2009
+ * Optional document content in plain text or markdown format. For file uploads, can be the document content.
1999
2010
  * @public
2000
2011
  */
2001
- originalName: string;
2012
+ content?: string | undefined;
2002
2013
  /**
2003
- * 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)
2014
+ * Timestamp when the document was last updated (ISO 8601 format). Example: 2021-01-01T00:00:00Z
2004
2015
  * @public
2005
2016
  */
2006
- originalId?: string | undefined;
2017
+ updatedAt?: string | undefined;
2007
2018
  /**
2008
2019
  * The unique identifier of the tenant when a service token is used.
2009
2020
  * @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.4",
4
+ "version": "0.1.6",
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",