@coveo/platform-client 0.0.0-cjs-attempt

package/dist/types/resources/Catalogs/CatalogInterfaces.d.ts

@@ -0,0 +1,338 @@
+export interface CatalogsListOptions {
+    /**
+     * Filter that will be matched against the catalog name, description and its configuration name.
+     */
+    filter?: string;
+    /**
+     * The 0-based index number of the page of catalogs to retrieve.
+     */
+    page?: number;
+    /**
+     * The number of catalogs to list per page.
+     */
+    pageSize?: number;
+}
+export type CatalogConfigurationsListOptions = Omit<CatalogsListOptions, 'filter'>;
+export interface CatalogFieldsOptions {
+    /**
+     * If true, the database cache will be bypassed. This will resolve your fields once, and save them into the database.
+     */
+    bypassCache?: boolean;
+}
+export interface CatalogFieldsMapping {
+    /**
+     * Mapping of index fields to standard commerce fields
+     */
+    [name: string]: string;
+}
+export interface CreateCatalogConfigurationModel {
+    /**
+     * The unique identifier of the catalog configuration.
+     */
+    id: string;
+    /**
+     * The name of the catalog configuration.
+     */
+    name: string;
+    /**
+     * The configuration product structure
+     */
+    product: Omit<CreateProductHierarchyModel, 'fields'>;
+    /**
+     * The configuration variant structure
+     */
+    variant?: Omit<CreateVariantHierarchyModel, 'fields'>;
+    /**
+     * The configuration availability structure
+     */
+    availability?: Omit<CreateAvailabilityHierarchyModel, 'fields'>;
+    /**
+     * The configuration mapping of index fields to standard commerce fields
+     */
+    fieldsMapping: CatalogFieldsMapping;
+}
+export interface CatalogConfigurationModel {
+    /**
+     * The unique identifier of the catalog configuration.
+     */
+    id: string;
+    /**
+     * The name of the catalog configuration.
+     */
+    name: string;
+    /**
+     * The configuration product structure
+     */
+    product: HierarchyWithFields<ProductHierarchyModel>;
+    /**
+     * The configuration variant structure
+     */
+    variant?: HierarchyWithFields<VariantHierarchyModel>;
+    /**
+     * The configuration availability structure
+     */
+    availability?: HierarchyWithFields<AvailabilityHierarchyModel>;
+    /**
+     * The configuration mapping of index fields to standard commerce fields
+     */
+    fieldsMapping: CatalogFieldsMapping;
+    /**
+     * Catalogs associated to the configuration
+     */
+    associatedCatalogs: IAssociatedCatalogModel[];
+}
+export interface IAssociatedCatalogModel {
+    /**
+     * The unique identifier of the catalog
+     */
+    id: string;
+    /**
+     * The name of the catalog
+     */
+    name: string;
+    /**
+     * The source containing catalog products
+     */
+    sourceId?: string;
+    /**
+     * The source containing catalog availabilities
+     */
+    availabilitySourceId?: string;
+}
+export interface BaseCatalogModel {
+    /**
+     * The unique identifier of the catalog
+     */
+    id: string;
+    /**
+     * The name of the catalog
+     */
+    name: string;
+    /**
+     * The description of the catalog
+     */
+    description?: string;
+    /**
+     * The source containing catalog products
+     */
+    sourceId?: string;
+    /**
+     * The source containing catalog availabilities
+     */
+    availabilitySourceId?: string;
+    /**
+     * @deprecated use `sourceId` and `availabilitySourceId` instead.
+     */
+    scope?: ScopeModel;
+}
+export type HierarchyWithFields<T extends {
+    fields?: string[];
+}> = Omit<T, 'fields'> & {
+    /**
+     * Fields for a specific object type
+     */
+    fields: string[];
+};
+interface Updated {
+    /**
+     * Cache last updated timestamp
+     */
+    lastUpdated: number;
+    /**
+     * Cache next update timestamp
+     */
+    nextUpdate: number;
+}
+interface Cached<T> extends Updated {
+    /**
+     * Cached items
+     */
+    item: T;
+}
+interface CatalogFieldsModel {
+    /**
+     * Fields for the product object type
+     */
+    productFields: string[];
+    /**
+     * Fields for the variant object type
+     */
+    variantFields: string[];
+    /**
+     * Fields for the availability object type
+     */
+    availabilityFields: string[];
+}
+export type CachedCatalogFieldsModel = Cached<CatalogFieldsModel>;
+export interface CatalogModel extends BaseCatalogModel {
+    /**
+     * @deprecated use `configuration.product` instead.
+     */
+    product: ProductHierarchyModel;
+    /**
+     * @deprecated use `configuration.variant` instead.
+     */
+    variant?: HierarchyWithFields<VariantHierarchyModel>;
+    /**
+     * @deprecated use `configuration.availability` instead.
+     */
+    availability?: HierarchyWithFields<AvailabilityHierarchyModel>;
+    /**
+     * The related catalog configuration id
+     */
+    catalogConfigurationId?: string;
+    /**
+     * The catalog configuration
+     */
+    configuration?: CatalogConfigurationModel;
+}
+export type CreateCatalogModel = BaseCatalogModel & ({
+    product?: CreateProductHierarchyModel;
+    variant?: CreateVariantHierarchyModel;
+    availability?: CreateAvailabilityHierarchyModel;
+    catalogConfigurationId?: never;
+} | {
+    product?: never;
+    variant?: never;
+    availability?: never;
+    catalogConfigurationId: string;
+});
+export interface FieldsSuggestionsQueryModel {
+    /**
+     * Source names for which to retrieve product and variant field suggestions
+     */
+    sourceNames: string[];
+    /**
+     * Source names for which to retrievee availability field suggestions
+     */
+    availabilitySourceNames?: string[];
+    /**
+     * The product object type
+     */
+    productObjectType: string;
+    /**
+     * The variant object type
+     */
+    variantObjectType?: string;
+    /**
+     * The availability object type
+     */
+    availabilityObjectType?: string;
+}
+export interface FieldsSuggestionsModel {
+    /**
+     * List of field suggestions
+     */
+    fields: FieldSuggestions[];
+}
+export interface FieldSuggestions {
+    /**
+     * Suggested field name
+     */
+    name: string;
+    /**
+     * Example values for the field
+     */
+    examples: string[];
+}
+export interface ProductHierarchyModel {
+    /**
+     * @deprecated `fields` will be ignored by the service on creation or update, but is kept for backward compatibility.
+     */
+    fields?: string[];
+    /**
+     * Field used as the unique product identifier
+     */
+    idField: string;
+    /**
+     * Product object type
+     */
+    objectType: string;
+}
+export type CreateProductHierarchyModel = ProductHierarchyModel;
+export interface VariantHierarchyModel {
+    /**
+     * @deprecated `fields` will be ignored by the service on creation or update, but is kept for backward compatibility.
+     */
+    fields: string[];
+    /**
+     * Field used as the unique variant identifier
+     */
+    idField: string;
+    /**
+     * Variant object type
+     */
+    objectType: string;
+}
+export type CreateVariantHierarchyModel = VariantHierarchyModel;
+export interface AvailabilityHierarchyModel {
+    /**
+     * Field used to contain the list of SKUs for an availability
+     */
+    availableSkusField: string;
+    /**
+     * @deprecated `fields` will be ignored by the service on creation or update, but is kept for backward compatibility.
+     */
+    fields: string[];
+    /**
+     * Field used as the unique availability identifier
+     */
+    idField?: string;
+    /**
+     * Availability object type
+     */
+    objectType: string;
+}
+export type CreateAvailabilityHierarchyModel = AvailabilityHierarchyModel & {
+    /**
+     * Field used as the unique availability identifier
+     */
+    idField: string;
+};
+export type ScopeModel = {
+    query: string;
+} | {
+    query?: string;
+    sourceIds: string[];
+};
+export interface CachedCatalogFieldStatsModel extends Updated {
+    /**
+     * List of field statistics
+     */
+    fieldStats: FieldStatsModel[];
+}
+export interface FieldStatsItemModel {
+    /**
+     * Number of objects in the catalog with this field
+     */
+    objectsWithField: number;
+    /**
+     * Number of objects in the catalog with this type
+     */
+    objectsWithType: number;
+}
+export interface FieldStatsModel {
+    /**
+     * Field name
+     */
+    fieldName: string;
+    /**
+     * The field stats for product structure
+     */
+    product: FieldStatsItemModel;
+    /**
+     * The field stats for variant structure
+     */
+    variant: FieldStatsItemModel;
+    /**
+     * The field stats for availability structure
+     */
+    availability: FieldStatsItemModel;
+}
+export interface CatalogFieldStatsOptions {
+    /**
+     * Wether we need to force a refresh of field statistics. Field statistics are cached and computed on a regular interval.
+     */
+    forceRefresh?: boolean;
+}
+export {};

package/dist/types/resources/Catalogs/ProductListing.d.ts

@@ -0,0 +1,14 @@
+import { New, PageModel } from '../BaseInterfaces.js';
+import Resource from '../Resource.js';
+import { ProductListingsListOptions, ProductListingModel, CatalogProductListingsGroupModel } from './ProductListingInterfaces.js';
+export default class ProductListing extends Resource {
+    static baseCatalogsUrl: string;
+    static baseProductListingsUrl: string;
+    list(catalogId: string, options?: ProductListingsListOptions): Promise<PageModel<ProductListingModel, "items">>;
+    create(catalogId: string, model: New<ProductListingModel>): Promise<ProductListingModel>;
+    delete(catalogId: string, productListingId: string): Promise<Record<string, unknown>>;
+    get(catalogId: string, productListingId: string): Promise<ProductListingModel>;
+    update(catalogId: string, model: ProductListingModel): Promise<ProductListingModel>;
+    getByCatalog(): Promise<PageModel<CatalogProductListingsGroupModel, "items">>;
+    getUrls(): Promise<string[]>;
+}

package/dist/types/resources/Catalogs/ProductListingConfiguration.d.ts

@@ -0,0 +1,11 @@
+import { New, PageModel } from '../BaseInterfaces.js';
+import Resource from '../Resource.js';
+import { ProductListingConfigurationModel, ProductListingConfigurationOptions } from './ProductListingConfigurationInterfaces.js';
+export default class ProductListingConfiguration extends Resource {
+    static baseUrl: string;
+    list(catalogId: string, productListingId: string, options?: ProductListingConfigurationOptions): Promise<PageModel<ProductListingConfigurationModel, "items">>;
+    create(catalogId: string, productListingId: string, rankingConfiguration: New<ProductListingConfigurationModel>): Promise<Record<string, unknown>>;
+    delete(catalogId: string, productListingId: string, productListingConfigurationId: string): Promise<Record<string, unknown>>;
+    get(catalogId: string, productListingId: string, productListingConfigurationId: string): Promise<ProductListingConfigurationModel>;
+    update(catalogId: string, productListingId: string, productListingConfigurationId: string, rankingConfiguration: New<ProductListingConfigurationModel>): Promise<Record<string, unknown>>;
+}

package/dist/types/resources/Catalogs/ProductListingConfigurationInterfaces.d.ts

@@ -0,0 +1,41 @@
+import { Paginated } from '../BaseInterfaces.js';
+import { DeprecatedPaginated } from '../InternalBaseInterface.js';
+import { QueryFilterModel } from './ProductListingInterfaces.js';
+export type ProductListingConfigurationOptions = Paginated | DeprecatedPaginated;
+export interface ProductListingConfigurationModel {
+    /**
+     * The id of the ProductListingConfiguration.
+     */
+    id: string;
+    /**
+     * The list of RankingConfiguration.
+     */
+    rankingConfigurations: RankingConfiguration[];
+}
+export interface RankingConfiguration {
+    /**
+     * The name of the RankingConfiguration.
+     */
+    name: string;
+    /**
+     * The list of inclusion filters.
+     */
+    include: QueryFilterModel[];
+    /**
+     * The list of exclusion filters.
+     */
+    exclude: QueryFilterModel[];
+    /**
+     * The type of the RankingConfiguration.
+     */
+    type: RankingTypeEnum;
+    /**
+     * The modifier value if type is BOOST or BURY. The index value if type is PIN.
+     */
+    value: number;
+}
+export declare enum RankingTypeEnum {
+    BOOST = "BOOST",
+    BURY = "BURY",
+    PIN = "PIN"
+}

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

@@ -0,0 +1,81 @@
+import { Paginated } from '../BaseInterfaces.js';
+import { FieldOperatorType, FieldValueType } from '../Enums.js';
+import { DeprecatedPaginated } from '../InternalBaseInterface.js';
+export type ProductListingsListOptions = Paginated | DeprecatedPaginated;
+interface FieldValueModelGeneric<T extends FieldValueType> {
+    /**
+     * The type of the field.
+     */
+    type: T;
+    /**
+     * The value of the field.
+     */
+    value: ValueTypeForFieldValueType[T];
+}
+interface ValueTypeForFieldValueType {
+    [FieldValueType.RANGE]: number[];
+    [FieldValueType.STRING]: string;
+    [FieldValueType.DECIMAL]: number;
+    [FieldValueType.ARRAY]: string[];
+    [FieldValueType.HIERARCHIC_MULTI_VALUE]: string[];
+}
+type FieldValueModel = FieldValueModelGeneric<FieldValueType.RANGE> | FieldValueModelGeneric<FieldValueType.STRING> | FieldValueModelGeneric<FieldValueType.DECIMAL> | FieldValueModelGeneric<FieldValueType.ARRAY> | FieldValueModelGeneric<FieldValueType.HIERARCHIC_MULTI_VALUE>;
+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;
+}
+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;
+}
+export {};

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

@@ -0,0 +1,7 @@
+export * from './Catalog.js';
+export * from './CatalogConfiguration.js';
+export * from './CatalogInterfaces.js';
+export * from './ProductListing.js';
+export * from './ProductListingInterfaces.js';
+export * from './ProductListingConfiguration.js';
+export * from './ProductListingConfigurationInterfaces.js';

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

@@ -0,0 +1,9 @@
+import Resource from '../../Resource.js';
+import { ClusterNodeUpgradeDataModel } from '../ClusterInterfaces.js';
+import { ClusterNodeUpgradeModel } from '../Nodes/index.js';
+import { ClusterAgentModel } from './ClusterAgentInterfaces.js';
+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/types/resources/Clusters/Agents/ClusterAgentInterfaces.d.ts

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

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

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

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

@@ -0,0 +1,18 @@
+import API from '../../APICore.js';
+import Resource from '../Resource.js';
+import ClusterAgent from './Agents/ClusterAgent.js';
+import { ClusterModel, ClusterStatusModel } from './ClusterInterfaces.js';
+import ClusterNode from './Nodes/ClusterNode.js';
+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("./index.js").ClusterAgentModel[]>;
+    live(): Promise<ClusterModel>;
+    status(id: string): Promise<ClusterStatusModel>;
+    synchronize(id: string): Promise<Record<string, unknown>>;
+}

package/dist/types/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/types/resources/Clusters/Nodes/ClusterNode.d.ts

@@ -0,0 +1,12 @@
+import Resource from '../../Resource.js';
+import { ClusterNodeUpgradeDataModel } from '../ClusterInterfaces.js';
+import { ClusterNodeModel, ClusterNodeUpgradeModel } from './ClusterNodeInterfaces.js';
+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/types/resources/Clusters/Nodes/ClusterNodeInterfaces.d.ts

@@ -0,0 +1,20 @@
+import { ClusterNodeStatusModel } from '../ClusterInterfaces.js';
+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/types/resources/Clusters/Nodes/index.d.ts

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

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

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

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

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