@coveo/platform-client 37.3.0 → 37.5.0-alpha.0

package/dist/definitions/resources/Clusters/index.d.ts

@@ -1,4 +1,4 @@
-export * from './Cluster';
-export * from './ClusterInterfaces';
-export * from './Agents/';
-export * from './Nodes/';
+export * from './Cluster';
+export * from './ClusterInterfaces';
+export * from './Agents/';
+export * from './Nodes/';

package/dist/definitions/resources/Connectivity/Connectivity.d.ts

@@ -1,7 +1,7 @@
-import Resource from '../Resource';
-import { LogRequest, LogRequestId, LogRequestResourceType, LogRequestResult } from './ConnectivityInterface';
-export default class Connectivity extends Resource {
-    static baseUrl: string;
-    requestLog(body: LogRequest, type?: LogRequestResourceType): Promise<LogRequestId>;
-    getLogRequestState(logRequestId: string): Promise<LogRequestResult>;
-}
+import Resource from '../Resource';
+import { LogRequest, LogRequestId, LogRequestResourceType, LogRequestResult } from './ConnectivityInterface';
+export default class Connectivity extends Resource {
+    static baseUrl: string;
+    requestLog(body: LogRequest, type?: LogRequestResourceType): Promise<LogRequestId>;
+    getLogRequestState(logRequestId: string): Promise<LogRequestResult>;
+}

package/dist/definitions/resources/Connectivity/ConnectivityInterface.d.ts

@@ -1,16 +1,16 @@
-export interface LogRequestResult {
-    state: string;
-    url?: string;
-    error?: string;
-}
-export interface LogRequestId {
-    value: string;
-}
-export interface LogRequest {
-    resourceId: string;
-    activityId: string;
-}
-export declare enum LogRequestResourceType {
-    SOURCE = "SOURCE",
-    SECURITY_PROVIDER = "SECURITY_PROVIDER"
-}
+export interface LogRequestResult {
+    state: string;
+    url?: string;
+    error?: string;
+}
+export interface LogRequestId {
+    value: string;
+}
+export interface LogRequest {
+    resourceId: string;
+    activityId: string;
+}
+export declare enum LogRequestResourceType {
+    SOURCE = "SOURCE",
+    SECURITY_PROVIDER = "SECURITY_PROVIDER"
+}

package/dist/definitions/resources/Connectivity/index.d.ts

@@ -1,2 +1,2 @@
-export * from './Connectivity';
-export * from './ConnectivityInterface';
+export * from './Connectivity';
+export * from './ConnectivityInterface';

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

@@ -1,16 +1,16 @@
-import Resource from '../Resource';
-import { ComponentVersion, CrawlingModuleEntity, CrawlingModuleLogRequestDownloadModel, CrawlingModuleLogRequestModel, CrawlingModuleLogRequestState, CreateCrawlingModuleLogRequestModel, MaestroVersionOptions, UpdateStatus } from './CrawlingModuleInterfaces';
-import { PageModel } from '../BaseInterfaces';
-export default class CrawlingModule extends Resource {
-    static baseUrl: string;
-    static connectivityBaseUrl: string;
-    list(): Promise<CrawlingModuleEntity[]>;
-    getUpdateStatus(crawlingModuleId: string): Promise<UpdateStatus>;
-    getMaestroVersions(options?: MaestroVersionOptions): Promise<ComponentVersion>;
-    listDatabaseVersions(): Promise<string[]>;
-    listWorkerVersions(): Promise<string[]>;
-    listSecurityWorkerVersions(): Promise<string[]>;
-    getLogRequests(crawlingModuleId: string, requestState: CrawlingModuleLogRequestState): Promise<PageModel<CrawlingModuleLogRequestModel, "items">>;
-    createLogRequest(crawlingModuleId: string, requestModel: CreateCrawlingModuleLogRequestModel): Promise<CrawlingModuleLogRequestModel>;
-    getLogRequestDownload(crawlingModuleId: string, logRequestId: string): Promise<CrawlingModuleLogRequestDownloadModel>;
-}
+import Resource from '../Resource';
+import { ComponentVersion, CrawlingModuleEntity, CrawlingModuleLogRequestDownloadModel, CrawlingModuleLogRequestModel, CrawlingModuleLogRequestState, CreateCrawlingModuleLogRequestModel, MaestroVersionOptions, UpdateStatus } from './CrawlingModuleInterfaces';
+import { PageModel } from '../BaseInterfaces';
+export default class CrawlingModule extends Resource {
+    static baseUrl: string;
+    static connectivityBaseUrl: string;
+    list(): Promise<CrawlingModuleEntity[]>;
+    getUpdateStatus(crawlingModuleId: string): Promise<UpdateStatus>;
+    getMaestroVersions(options?: MaestroVersionOptions): Promise<ComponentVersion>;
+    listDatabaseVersions(): Promise<string[]>;
+    listWorkerVersions(): Promise<string[]>;
+    listSecurityWorkerVersions(): Promise<string[]>;
+    getLogRequests(crawlingModuleId: string, requestState: CrawlingModuleLogRequestState): Promise<PageModel<CrawlingModuleLogRequestModel, "items">>;
+    createLogRequest(crawlingModuleId: string, requestModel: CreateCrawlingModuleLogRequestModel): Promise<CrawlingModuleLogRequestModel>;
+    getLogRequestDownload(crawlingModuleId: string, logRequestId: string): Promise<CrawlingModuleLogRequestDownloadModel>;
+}

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

@@ -1,57 +1,180 @@
-import { UpdateStatusCategory } from '../Enums';
-export interface MaestroVersionOptions {
-    crawlingModuleVersion: string;
-}
-export interface CrawlingModuleEntity {
-    createdDate: number;
-    databaseVersion?: string;
-    disabled: boolean;
-    id: string;
-    lastHeartbeat: number;
-    lastVersionUpgrade: number;
-    maestroVersion: string;
-    name: string;
-    organizationId: string;
-    securityWorkerVersion?: string;
-    updatedDate: number;
-    workerVersion?: string;
-}
-export interface ComponentVersion {
-    databaseVersion: string;
-    maestroVersion: string;
-    securityWorkerVersion: string;
-    workerVersion: string;
-}
-export interface UpdateStatus {
-    updateAvailable: boolean;
-    updateCategory: UpdateStatusCategory;
-}
-export declare enum CrawlingModuleLogRequestLogType {
-    MAESTRO = "MAESTRO",
-    WORKER = "WORKER"
-}
-export declare enum CrawlingModuleLogRequestState {
-    CREATED = "CREATED",
-    ERROR = "ERROR",
-    RUNNING = "RUNNING",
-    SUCCESSFUL = "SUCCESSFUL",
-    TIMEOUT = "TIMEOUT"
-}
-export interface CrawlingModuleLogRequestModel {
-    createdDate: number;
-    id: string;
-    instanceId: string;
-    logType: CrawlingModuleLogRequestLogType;
-    operationId: string;
-    state: CrawlingModuleLogRequestState;
-}
-export interface CreateCrawlingModuleLogRequestModel {
-    instanceId: string;
-    logType: CrawlingModuleLogRequestLogType;
-    operationId: string;
-}
-export interface CrawlingModuleLogRequestDownloadModel {
-    info: string;
-    state: CrawlingModuleLogRequestState;
-    url: string;
-}
+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;
+    /**
+     * If an update is available, the category of update.
+     * See @type {UpdateStatusCategory}.
+     */
+    updateCategory?: UpdateStatusCategory;
+}
+export declare enum CrawlingModuleLogRequestLogType {
+    MAESTRO = "MAESTRO",
+    WORKER = "WORKER"
+}
+export declare enum CrawlingModuleLogRequestState {
+    CREATED = "CREATED",
+    ERROR = "ERROR",
+    RUNNING = "RUNNING",
+    SUCCESSFUL = "SUCCESSFUL",
+    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/definitions/resources/CrawlingModule/index.d.ts

@@ -1,2 +1,2 @@
-export * from './CrawlingModule';
-export * from './CrawlingModuleInterfaces';
+export * from './CrawlingModule';
+export * from './CrawlingModuleInterfaces';