@coveo/platform-client 35.0.0

package/dist/definitions/resources/Catalogs/ProductListingInterfaces.d.ts

@@ -0,0 +1,76 @@
+import { Paginated } from '../BaseInterfaces';
+import { FieldOperatorType, FieldValueType } from '../Enums';
+import { DeprecatedPaginated } from '../InternalBaseInterface';
+export declare type ProductListingsListOptions = Paginated | DeprecatedPaginated;
+export interface FieldValueModel {
+    /**
+     * The field type.
+     */
+    type: string;
+    /**
+     * The field value enum type.
+     */
+    value: FieldValueType;
+}
+export interface QueryFilterModel {
+    /**
+     * The field name.
+     */
+    fieldName: string;
+    /**
+     * The field operator.
+     */
+    operator: FieldOperatorType;
+    /**
+     * The field value.
+     */
+    value: FieldValueModel;
+}
+export interface ProductListingMetricsModel {
+    lastNumberOfProducts?: number;
+    lastQueried: string;
+}
+export interface ProductListingModel {
+    /**
+     * The list of exclusion filters.
+     */
+    exclude?: QueryFilterModel[];
+    /**
+     * The unique identifier of this product listing.
+     */
+    id?: string;
+    /**
+     * The list of inclusion filters.
+     */
+    include?: QueryFilterModel[];
+    /**
+     * The name of this product listing.
+     */
+    name: string;
+    /**
+     * The list of URLs for the product listing.
+     */
+    urls: string[];
+    /**
+     * The list of usage metrics.
+     */
+    metrics?: ProductListingMetricsModel;
+    /**
+     * The desired configuration
+     */
+    configuration?: Map<string, any>;
+}
+export interface CatalogProductListingsGroupModel {
+    /**
+     * The unique identifier of the catalog.
+     */
+    catalogId?: string;
+    /**
+     * The name of the catalog.
+     */
+    catalogName?: string;
+    /**
+     * The number of associated product listings.
+     */
+    productListingsCount?: number;
+}

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

@@ -0,0 +1,5 @@
+export * from './Catalog';
+export * from './CatalogConfiguration';
+export * from './CatalogInterfaces';
+export * from './ProductListing';
+export * from './ProductListingInterfaces';

package/dist/definitions/resources/Clusters/Agents/ClusterAgent.d.ts

@@ -0,0 +1,9 @@
+import Resource from '../../Resource';
+import { ClusterNodeUpgradeDataModel } from '../ClusterInterfaces';
+import { ClusterNodeUpgradeModel } from '../Nodes';
+import { ClusterAgentModel } from './ClusterAgentInterfaces';
+export default class ClusterAgent extends Resource {
+    static getBaseUrl: (id: string) => string;
+    list(clusterId: string): Promise<ClusterAgentModel[]>;
+    upgrade(clusterId: string, id: string, data: ClusterNodeUpgradeDataModel): Promise<ClusterNodeUpgradeModel[]>;
+}

package/dist/definitions/resources/Clusters/Agents/ClusterAgentInterfaces.d.ts

@@ -0,0 +1,9 @@
+import { ClusterNodeStatusModel } from '../ClusterInterfaces';
+export interface ClusterAgentModel {
+    id: string;
+    name: string;
+    description: string;
+    platform: string;
+    version: string;
+    status: ClusterNodeStatusModel;
+}

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

@@ -0,0 +1,2 @@
+export * from './ClusterAgent';
+export * from './ClusterAgentInterfaces';

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

@@ -0,0 +1,18 @@
+import API from '../../APICore';
+import Resource from '../Resource';
+import ClusterAgent from './Agents/ClusterAgent';
+import { ClusterModel, ClusterStatusModel } from './ClusterInterfaces';
+import ClusterNode from './Nodes/ClusterNode';
+export default class Cluster extends Resource {
+    protected api: API;
+    protected serverlessApi: API;
+    static baseUrl: string;
+    nodes: ClusterNode;
+    agents: ClusterAgent;
+    constructor(api: API, serverlessApi: API);
+    list(): Promise<ClusterModel[]>;
+    listAgents(id: string): Promise<import("./Agents").ClusterAgentModel[]>;
+    live(): Promise<ClusterModel>;
+    status(id: string): Promise<ClusterStatusModel>;
+    synchronize(id: string): Promise<Record<string, unknown>>;
+}

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

@@ -0,0 +1,92 @@
+export interface ClusterResource {
+    id: string;
+    name: string;
+    createdDate?: number;
+    status: 'QUEUED_TO_CREATE' | 'CREATING' | 'REMOVING' | 'UPGRADING' | 'PAUSED' | 'COMPLETED' | 'ERROR';
+    type: string;
+    numberOfRetries: number;
+}
+export interface ClusterStatusModel {
+    orgReadOnlyStatus: boolean;
+    currentProvisioningProgress: number;
+    initialProvisioningDone: boolean;
+    lastProvisioningCompletedDate?: number;
+    ongoing: boolean;
+    resources: ClusterResource[];
+    retryScheduled: boolean;
+    status: 'ERROR' | 'HEALTHY';
+}
+export interface ClusterTopologyModel {
+    agents: ClusterTopologyAgentModel[];
+    crawlerDbConnectionString: string;
+    dpmDocUri: string;
+    indexDocUri: string;
+    indexers: ClusterIndexerModel[];
+    rabbitServerId: string;
+    secCacheJobUri: string;
+    secClusterSyncUri: string;
+    securityCaches: ClusterSecurityCacheModel[];
+    securityProviderDbConnectionString: string;
+    securityProviders: ClusterSecurityProviderModel[];
+    topologyId: string;
+}
+export interface ClusterTopologyAgentModel {
+    id: string;
+    machineSpec: ClusterMachineSpecModel;
+    storages: ClusterStorageSpecModel[];
+}
+export interface ClusterStorageSpecModel {
+    numberOfIops: number;
+    sizeInGibibytes: number;
+    sizeInGigabytes: number;
+    storageType: 'STANDARD' | 'SSD' | 'PROVISIONED_SSD';
+}
+export interface ClusterMachineSpecModel {
+    architecture: string;
+    storageSpec: ClusterStorageSpecModel;
+}
+export interface ClusterComponentModel {
+    adminPort: number;
+    adminUri: string;
+    agentId: string;
+    componentName: string;
+    componentPlatform: string;
+    componentVersion: string;
+    id: string;
+    name: string;
+}
+export interface ClusterIndexerModel extends ClusterComponentModel {
+    indexerDocUri: string;
+    searchPort: number;
+    searchServerUri: string;
+}
+export interface ClusterSecurityCacheModel extends ClusterComponentModel {
+    secCacheSyncUri: string;
+}
+export interface ClusterSecurityProviderModel extends ClusterComponentModel {
+    type: string;
+    useDefaultConfiguration: boolean;
+}
+export interface ClusterModel {
+    id: string;
+    identityTargetMode: string;
+    liveCluster: boolean;
+    organizationId: string;
+    componentVersions: {
+        connectorsVersion: string;
+        indexerVersion: string;
+        securityCacheVersion: string;
+        securityProviderVersion: string;
+    };
+    clusterTopology: ClusterTopologyModel;
+}
+export interface ClusterNodeStatusModel {
+    message: string;
+    severity: string;
+    status: string;
+    timestamp: string;
+}
+export interface ClusterNodeUpgradeDataModel {
+    componentName: string;
+    version: string;
+}

package/dist/definitions/resources/Clusters/Nodes/ClusterNode.d.ts

@@ -0,0 +1,12 @@
+import Resource from '../../Resource';
+import { ClusterNodeUpgradeDataModel } from '../ClusterInterfaces';
+import { ClusterNodeModel, ClusterNodeUpgradeModel } from './ClusterNodeInterfaces';
+export default class ClusterNode extends Resource {
+    static getBaseUrl: (id: string) => string;
+    list(clusterId: string): Promise<ClusterNodeModel[]>;
+    listUpgrades(clusterId: string, id: string): Promise<ClusterNodeUpgradeModel[]>;
+    start(clusterId: string, id: string): Promise<Record<string, unknown>>;
+    stop(clusterId: string, id: string): Promise<Record<string, unknown>>;
+    dump(clusterId: string, id: string): Promise<Record<string, unknown>>;
+    upgrade(clusterId: string, id: string, data: ClusterNodeUpgradeDataModel): Promise<ClusterNodeUpgradeModel[]>;
+}

package/dist/definitions/resources/Clusters/Nodes/ClusterNodeInterfaces.d.ts

@@ -0,0 +1,20 @@
+import { ClusterNodeStatusModel } from '../ClusterInterfaces';
+export interface ClusterNodeModel {
+    adminURI: string;
+    agentId: string;
+    componentName: string;
+    id: string;
+    indexId: string;
+    instanceType: string;
+    isCustom: boolean;
+    latestVersion: string;
+    name: string;
+    params?: any;
+    status: ClusterNodeStatusModel;
+    version: string;
+}
+export interface ClusterNodeUpgradeModel {
+    name: string;
+    platform: string;
+    version: string;
+}

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

@@ -0,0 +1,2 @@
+export * from './ClusterNode';
+export * from './ClusterNodeInterfaces';

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

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

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

@@ -0,0 +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>;
+}

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

@@ -0,0 +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"
+}

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

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

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

@@ -0,0 +1,11 @@
+import Resource from '../Resource';
+import { ComponentVersion, CrawlingModuleEntity, MaestroVersionOptions, UpdateStatus } from './CrawlingModuleInterfaces';
+export default class CrawlingModule extends Resource {
+    static baseUrl: string;
+    list(): Promise<CrawlingModuleEntity[]>;
+    getUpdateStatus(crawlingModuleId: string): Promise<UpdateStatus>;
+    getMaestroVersions(options?: MaestroVersionOptions): Promise<ComponentVersion>;
+    listDatabaseVersions(): Promise<string[]>;
+    listWorkerVersions(): Promise<string[]>;
+    listSecurityWorkerVersions(): Promise<string[]>;
+}

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

@@ -0,0 +1,28 @@
+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;
+}

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

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