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

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.SearchThresholdValue = exports.SearchStrategy = exports.SyncLogLevel = exports.SyncDataSourceStatus = exports.SyncDataSourceMode = exports.DocumentStatus = exports.ConfluenceSpaceType = exports.DataSourceType = exports.ScheduleConfiguration = exports.DataSourceConfig = exports.KnowledgeBaseNotFoundException = exports.DocumentNotFoundException = exports.DataSourceNotFoundException = exports.ValidationException = exports.UnauthorizedException = exports.ForbiddenException = void 0;
 const KnowledgeBaseServiceException_1 = require("./KnowledgeBaseServiceException");
 class ForbiddenException extends KnowledgeBaseServiceException_1.KnowledgeBaseServiceException {
     name = "ForbiddenException";
@@ -104,14 +104,7 @@ exports.DataSourceType = {
     FILES: "files",
     GDRIVE: "gdrive",
 };
-exports.DocumentStatus = {
-    COMPLETED: "completed",
-    DRAFT: "draft",
-    FAILED: "failed",
-    PENDING: "pending",
-    PROCESSING: "processing",
-};
-exports.DescribeDataSourceConfluenceSpaceType = {
+exports.ConfluenceSpaceType = {
     COLLABORATION: "collaboration",
     GLOBAL: "global",
     KNOWLEDGE_BASE: "knowledge_base",
@@ -119,6 +112,13 @@ exports.DescribeDataSourceConfluenceSpaceType = {
     PERSONAL: "personal",
     SYSTEM: "system",
 };
+exports.DocumentStatus = {
+    COMPLETED: "completed",
+    DRAFT: "draft",
+    FAILED: "failed",
+    PENDING: "pending",
+    PROCESSING: "processing",
+};
 exports.SyncDataSourceMode = {
     FULL: "full",
     INCREMENTAL: "incremental",

package/dist-es/models/models_0.js

@@ -95,14 +95,7 @@ export const DataSourceType = {
     FILES: "files",
     GDRIVE: "gdrive",
 };
-export const DocumentStatus = {
-    COMPLETED: "completed",
-    DRAFT: "draft",
-    FAILED: "failed",
-    PENDING: "pending",
-    PROCESSING: "processing",
-};
-export const DescribeDataSourceConfluenceSpaceType = {
+export const ConfluenceSpaceType = {
     COLLABORATION: "collaboration",
     GLOBAL: "global",
     KNOWLEDGE_BASE: "knowledge_base",
@@ -110,6 +103,13 @@ export const DescribeDataSourceConfluenceSpaceType = {
     PERSONAL: "personal",
     SYSTEM: "system",
 };
+export const DocumentStatus = {
+    COMPLETED: "completed",
+    DRAFT: "draft",
+    FAILED: "failed",
+    PENDING: "pending",
+    PROCESSING: "processing",
+};
 export const SyncDataSourceMode = {
     FULL: "full",
     INCREMENTAL: "incremental",

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

@@ -55,14 +55,44 @@ declare const ListHistoryStatisticsCommand_base: {
  * //     totalUniqueUsers: Number("int"), // required
  * //     recentUniqueUsers: Number("int"), // required
  * //     noResultsRequests: Number("int"), // required
- * //     dailyBreakdown: [ // DailyStatisticsList
- * //       { // DailyStatistics
+ * //     dailyBreakdown: [ // DailyGlobalStatisticsList
+ * //       { // DailyGlobalStatistics
  * //         date: "STRING_VALUE", // required
  * //         requests: Number("int"), // required
  * //         uniqueUsers: Number("int"), // required
  * //         noResultsRequests: Number("int"), // required
  * //       },
  * //     ],
+ * //     knowledgeBases: [ // KnowledgeBaseStatisticsList
+ * //       { // KnowledgeBaseStatistics
+ * //         knowledgeBaseId: "STRING_VALUE", // required
+ * //         searchDailyBreakdown: [ // DailySearchStatisticsList // required
+ * //           { // DailySearchStatistics
+ * //             date: "STRING_VALUE", // required
+ * //             requests: Number("int"), // required
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //     dataSources: [ // DataSourceStatisticsList
+ * //       { // DataSourceStatistics
+ * //         dataSourceId: "STRING_VALUE", // required
+ * //         searchDailyBreakdown: [ // required
+ * //           {
+ * //             date: "STRING_VALUE", // required
+ * //             requests: Number("int"), // required
+ * //           },
+ * //         ],
+ * //         documentsCount: Number("int"), // required
+ * //         documentsStatistics: [ // DocumentsStatisticsList // required
+ * //           { // DocumentsStatistics
+ * //             status: "draft" || "pending" || "processing" || "completed" || "failed", // required
+ * //             count: Number("int"), // required
+ * //           },
+ * //         ],
+ * //         chunksCount: Number("int"), // required
+ * //       },
+ * //     ],
  * //   },
  * // };
  *

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

@@ -366,6 +366,22 @@ export interface DataSourceItem {
 export interface ConfigureDataSourceOutput {
     dataSource: DataSourceItem;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ConfluenceSpaceType: {
+    readonly COLLABORATION: "collaboration";
+    readonly GLOBAL: "global";
+    readonly KNOWLEDGE_BASE: "knowledge_base";
+    readonly ONBOARDING: "onboarding";
+    readonly PERSONAL: "personal";
+    readonly SYSTEM: "system";
+};
+/**
+ * @public
+ */
+export type ConfluenceSpaceType = typeof ConfluenceSpaceType[keyof typeof ConfluenceSpaceType];
 /**
  * @public
  */
@@ -637,7 +653,7 @@ export interface CreateKnowledgeBaseOutput {
 /**
  * @public
  */
-export interface DailyStatistics {
+export interface DailyGlobalStatistics {
     /**
      * Date in format yyyy-MM-dd
      * @public
@@ -659,6 +675,42 @@ export interface DailyStatistics {
      */
     noResultsRequests: number;
 }
+/**
+ * @public
+ */
+export interface DailySearchStatistics {
+    /**
+     * Date in format yyyy-MM-dd
+     * @public
+     */
+    date: string;
+    /**
+     * Number of search requests
+     * @public
+     */
+    requests: number;
+}
+/**
+ * @public
+ */
+export interface DocumentsStatistics {
+    status: DocumentStatus;
+    count: number;
+}
+/**
+ * @public
+ */
+export interface DataSourceStatistics {
+    /**
+     * Unique identifier of the data source
+     * @public
+     */
+    dataSourceId: string;
+    searchDailyBreakdown: (DailySearchStatistics)[];
+    documentsCount: number;
+    documentsStatistics: (DocumentsStatistics)[];
+    chunksCount: number;
+}
 /**
  * @public
  */
@@ -744,22 +796,6 @@ export interface DescribeDataSourceConfluencePagesParameters {
      */
     enabled?: (string)[] | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const DescribeDataSourceConfluenceSpaceType: {
-    readonly COLLABORATION: "collaboration";
-    readonly GLOBAL: "global";
-    readonly KNOWLEDGE_BASE: "knowledge_base";
-    readonly ONBOARDING: "onboarding";
-    readonly PERSONAL: "personal";
-    readonly SYSTEM: "system";
-};
-/**
- * @public
- */
-export type DescribeDataSourceConfluenceSpaceType = typeof DescribeDataSourceConfluenceSpaceType[keyof typeof DescribeDataSourceConfluenceSpaceType];
 /**
  * @public
  */
@@ -768,7 +804,7 @@ export interface DescribeDataSourceConfluenceSpacesParameters {
      * Filter spaces by type.
      * @public
      */
-    type?: DescribeDataSourceConfluenceSpaceType | undefined;
+    type?: ConfluenceSpaceType | undefined;
 }
 /**
  * @public
@@ -914,7 +950,7 @@ export interface DescribeDataSourceConfluenceSpaceResult {
      * Type of the Confluence space
      * @public
      */
-    type: DescribeDataSourceConfluenceSpaceType;
+    type: ConfluenceSpaceType;
 }
 /**
  * @public
@@ -1365,6 +1401,17 @@ export interface GetKnowledgeBaseInput {
 export interface GetKnowledgeBaseOutput {
     knowledgeBase: KnowledgeBaseItem;
 }
+/**
+ * @public
+ */
+export interface KnowledgeBaseStatistics {
+    /**
+     * Unique identifier of the knowledge base
+     * @public
+     */
+    knowledgeBaseId: string;
+    searchDailyBreakdown: (DailySearchStatistics)[];
+}
 /**
  * @public
  */
@@ -1398,7 +1445,17 @@ export interface HistoryStatistics {
      * Daily breakdown of statistics for the last N days. Only present if daysBack is specified.
      * @public
      */
-    dailyBreakdown?: (DailyStatistics)[] | undefined;
+    dailyBreakdown?: (DailyGlobalStatistics)[] | undefined;
+    /**
+     * Statistics for each knowledge base
+     * @public
+     */
+    knowledgeBases?: (KnowledgeBaseStatistics)[] | undefined;
+    /**
+     * Statistics for each data source
+     * @public
+     */
+    dataSources?: (DataSourceStatistics)[] | undefined;
 }
 /**
  * @public

package/package.json

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