@coveo/platform-client 37.4.0 → 37.5.0

package/dist/definitions/resources/CrawlingModule/CrawlingModuleInterfaces.d.ts

@@ -2,29 +2,116 @@ import { UpdateStatusCategory } from '../Enums';
 export interface MaestroVersionOptions {
     crawlingModuleVersion: string;
 }
+export interface CrawlingModuleStatus {
+    /**
+     * Whether the Crawling Module is using a proxy or not.
+     */
+    usingProxy: boolean;
+    /**
+     * Whether auto-updates are enabled or not on this setup.
+     */
+    autoUpdateEnable: boolean;
+    /**
+     * Whether remote log requests are enabled or not.
+     * This enables the client to query logs directly from the platform.
+     */
+    logRequestEnable: boolean;
+    /**
+     * Frequency at which the setup polls for updates.
+     */
+    autoUpdateFrequency: number;
+    /**
+     * The number of crawler workers set in the configuration of the Crawling Module.
+     */
+    numberOfCrawlerWorkers: number;
+    /**
+     * The number of security provider set in the configuration of the Crawling Module.
+     */
+    numberOfSecurityWorkers: number;
+}
 export interface CrawlingModuleEntity {
+    /**
+     * Creation date.
+     */
     createdDate: number;
+    /**
+     * @deprecated Should not be used.
+     */
     databaseVersion?: string;
+    /**
+     * After a given period, a Crawling Module that doesn't report to the
+     * platform is going be disabled. It is considered unable to process job.
+     */
     disabled: boolean;
+    /**
+     * Id of the Crawling Module.
+     */
     id: string;
+    /**
+     * The last time the Crawling Module sent its status to the platform.
+     */
     lastHeartbeat: number;
+    /**
+     * The latest date at which the Crawling Module update itself.
+     */
     lastVersionUpgrade: number;
+    /**
+     * The version of the Crawling Module.
+     */
     maestroVersion: string;
+    /**
+     * The name of the Crawling Module.
+     */
     name: string;
+    /**
+     * Organization id with which the Crawling Module is linked.
+     */
     organizationId: string;
+    /**
+     * @deprecated Should not be used.
+     */
     securityWorkerVersion?: string;
+    /**
+     * Latest updated date.
+     */
     updatedDate: number;
+    /**
+     * @deprecated Should not be used.
+     */
     workerVersion?: string;
+    /**
+     * Advanced information about a crawling module, see @type {CrawlingModuleStatus}.
+     */
+    status?: CrawlingModuleStatus;
 }
 export interface ComponentVersion {
+    /**
+     * @deprecated Should not be used.
+     */
     databaseVersion: string;
+    /**
+     * The version of the Crawling Module.
+     */
     maestroVersion: string;
+    /**
+     * @deprecated Should not be used.
+     */
     securityWorkerVersion: string;
+    /**
+     * @deprecated Should not be used.
+     */
     workerVersion: string;
 }
 export interface UpdateStatus {
+    /**
+     * Whether an update is available.
+     */
     updateAvailable: boolean;
-    updateCategory: UpdateStatusCategory;
+    /**
+     * If an update is available, the category of update.
+     * See @type {UpdateStatusCategory}.
+     */
+    updateCategory?: UpdateStatusCategory;
 }
 export declare enum CrawlingModuleLogRequestLogType {
     MAESTRO = "MAESTRO",
@@ -38,20 +125,56 @@ export declare enum CrawlingModuleLogRequestState {
     TIMEOUT = "TIMEOUT"
 }
 export interface CrawlingModuleLogRequestModel {
+    /**
+     * Creation date for the log request.
+     */
     createdDate: number;
+    /**
+     * Id of the log request.
+     */
     id: string;
+    /**
+     * InstanceId for the log request.
+     */
     instanceId: string;
+    /**
+     * The type of log requested, see @type {CrawlingModuleLogRequestLogType}
+     */
     logType: CrawlingModuleLogRequestLogType;
+    /**
+     * Operation for which we want to get the logs.
+     */
     operationId: string;
+    /**
+     * The state of the request, see @enum {CrawlingModuleLogRequestState}
+     */
     state: CrawlingModuleLogRequestState;
 }
 export interface CreateCrawlingModuleLogRequestModel {
+    /**
+     * InstanceId for the log request.
+     */
     instanceId: string;
+    /**
+     * The type of log requested, see @type {CrawlingModuleLogRequestLogType}
+     */
     logType: CrawlingModuleLogRequestLogType;
+    /**
+     * Operation for which we want to get the logs.
+     */
     operationId: string;
 }
 export interface CrawlingModuleLogRequestDownloadModel {
+    /**
+     * Information about the request. Typically contains error messages.
+     */
     info: string;
+    /**
+     * The state of the request, see @enum {CrawlingModuleLogRequestState}
+     */
     state: CrawlingModuleLogRequestState;
+    /**
+     * Url to download the log.
+     */
     url: string;
 }

package/dist/resources/CrawlingModule/CrawlingModuleInterfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"CrawlingModuleInterfaces.js","sourceRoot":"","sources":["../../../src/resources/CrawlingModule/CrawlingModuleInterfaces.ts"],"names":[],"mappings":";;;AAiCA,IAAY,+BAGX;AAHD,WAAY,+BAA+B;IACvC,sDAAmB,CAAA;IACnB,oDAAiB,CAAA;AACrB,CAAC,EAHW,+BAA+B,GAA/B,uCAA+B,KAA/B,uCAA+B,QAG1C;AAED,IAAY,6BAMX;AAND,WAAY,6BAA6B;IACrC,oDAAmB,CAAA;IACnB,gDAAe,CAAA;IACf,oDAAmB,CAAA;IACnB,0DAAyB,CAAA;IACzB,oDAAmB,CAAA;AACvB,CAAC,EANW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAMxC"}
+{"version":3,"file":"CrawlingModuleInterfaces.js","sourceRoot":"","sources":["../../../src/resources/CrawlingModule/CrawlingModuleInterfaces.ts"],"names":[],"mappings":";;;AAyHA,IAAY,+BAGX;AAHD,WAAY,+BAA+B;IACvC,sDAAmB,CAAA;IACnB,oDAAiB,CAAA;AACrB,CAAC,EAHW,+BAA+B,GAA/B,uCAA+B,KAA/B,uCAA+B,QAG1C;AAED,IAAY,6BAMX;AAND,WAAY,6BAA6B;IACrC,oDAAmB,CAAA;IACnB,gDAAe,CAAA;IACf,oDAAmB,CAAA;IACnB,0DAAyB,CAAA;IACzB,oDAAmB,CAAA;AACvB,CAAC,EANW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAMxC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "37.4.0",
+    "version": "37.5.0",
     "description": "",
     "main": "dist/Entry.js",
     "types": "dist/definitions/Entry.d.ts",