@coveo/platform-client 60.8.0 → 61.1.0

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

@@ -1,53 +0,0 @@
-import { Paginated } from '../BaseInterfaces.js';
-import { DeprecatedPaginated } from '../InternalBaseInterface.js';
-import { QueryFilterModel } from './ProductListingInterfaces.js';
-/**
- * @deprecated
- */
-export type ProductListingConfigurationOptions = Paginated | DeprecatedPaginated;
-/**
- * @deprecated
- */
-export interface ProductListingConfigurationModel {
-    /**
-     * The id of the ProductListingConfiguration.
-     */
-    id: string;
-    /**
-     * The list of RankingConfiguration.
-     */
-    rankingConfigurations: RankingConfiguration[];
-}
-/**
- * @deprecated
- */
-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;
-}
-/**
- * @deprecated
- */
-export declare enum RankingTypeEnum {
-    BOOST = "BOOST",
-    BURY = "BURY",
-    PIN = "PIN"
-}

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

@@ -1,96 +0,0 @@
-import { Paginated } from '../BaseInterfaces.js';
-import { FieldOperatorType, FieldValueType } from '../Enums.js';
-import { DeprecatedPaginated } from '../InternalBaseInterface.js';
-/**
- * @deprecated
- */
-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>;
-/**
- * @deprecated
- */
-export interface QueryFilterModel {
-    /**
-     * The field name.
-     */
-    fieldName: string;
-    /**
-     * The field operator.
-     */
-    operator: FieldOperatorType;
-    /**
-     * The field value.
-     */
-    value: FieldValueModel;
-}
-/**
- * @deprecated
- */
-export interface ProductListingMetricsModel {
-    lastNumberOfProducts?: number;
-    lastQueried: string;
-}
-/**
- * @deprecated
- */
-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;
-}
-/**
- * @deprecated
- */
-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/Products/Product.d.ts

@@ -1,12 +0,0 @@
-import { New } from '../BaseInterfaces.js';
-import Resource from '../Resource.js';
-import { ProductsRequestModel, ProductsResultModel } from './ProductInterfaces.js';
-export default class Products extends Resource {
-    static baseUrl: string;
-    /**
-     * @param productsRequest
-     * @param refreshCache
-     * @deprecated
-     */
-    get(productsRequest: New<ProductsRequestModel>, refreshCache?: boolean): Promise<ProductsResultModel>;
-}

package/dist/types/resources/Products/ProductInterfaces.d.ts

@@ -1,254 +0,0 @@
-import { ProductsFacetRequestSortType, ProductsSortByType, SortingOrder } from '../Enums.js';
-/**
- * @deprecated
- */
-export interface AdvancedFiltersModel {
-    queryFilter: string;
-}
-/**
- * @deprecated
- */
-export interface AdvancedParametersModel {
-    /**
-     * Used to retrieve debug information. Will have an impact on query performance.
-     */
-    debug?: boolean;
-    /**
-     * Used to retrieve all documents regardless of their security model.
-     */
-    viewAllContent?: boolean;
-}
-/**
- * @deprecated
- */
-export interface FacetRequestOptions {
-    /**
-     * Whether to take into account the scores generated by the index when reordering facets.
-     */
-    enableIndexFacetOrdering?: boolean;
-    /**
-     * Whether facets should be returned in the same order in which they were requested.
-     */
-    freezeFacetOrder?: boolean;
-}
-/**
- * @deprecated
- */
-export interface FacetRequestItem {
-    /**
-     * The values displayed by the facet in the search interface at the moment of the request.
-     */
-    currentValues?: any[];
-    /**
-     * A custom sort order for the facet values.
-     */
-    customOrder?: string[];
-    /**
-     * The unique identifier of the facet in the search interface.
-     */
-    facetId?: string;
-    /**
-     * The name of the field on which to base the facet request.
-     */
-    field: string;
-    /**
-     * Whether the facet is expanded in the search interface at the moment of the request.
-     */
-    isFieldExpanded?: boolean;
-    /**
-     * The maximum number of facet values to fetch.
-     */
-    numberOfValues?: number;
-    /**
-     * Whether to prevent Coveo ML from automatically selecting facet values.
-     */
-    preventAutoSelect?: boolean;
-    /**
-     * The criterion to use for sorting returned facet values.
-     */
-    sortCriteria?: ProductsFacetRequestSortType;
-}
-/**
- * @deprecated
- */
-export interface FacetsRequestModel {
-    /**
-     * The facet options to add to the request.
-     */
-    options?: FacetRequestOptions;
-    /**
-     * The facet operations to perform on the products listings.
-     */
-    requests: FacetRequestItem[];
-}
-/**
- * @deprecated
- */
-export interface PaginatedModel {
-    /**
-     * The number of elements to list per page.
-     */
-    numberOfValues?: number;
-    /**
-     * The 0-based index number of the page of elements to retrieve.
-     */
-    page?: number;
-}
-/**
- * @deprecated
- */
-export interface SortByFields {
-    /**
-     * The name of the field.
-     */
-    name: string;
-    /**
-     * The sorting direction.
-     */
-    direction: SortingOrder;
-}
-/**
- * @deprecated
- */
-export interface SortModel {
-    /**
-     * The name of the field to sort by.
-     */
-    by: ProductsSortByType;
-    /**
-     * The fields to take into consideration when sorting.
-     */
-    fields?: SortByFields[];
-}
-/**
- * @deprecated
- */
-export interface ProductsRequestModel {
-    /**
-     * Additional fields allow you to collect additional information, besides the standard data.
-     */
-    additionalFields?: string[];
-    /**
-     *
-     */
-    advancedFiltersModel?: AdvancedFiltersModel;
-    /**
-     * Advanced parameters to retrieve more information from the search queries.
-     */
-    advancedParameters?: AdvancedParametersModel;
-    /**
-     * An anonymous identifier used to determine from which identity the query comes from.
-     */
-    clientId?: string;
-    /**
-     * Parameters related to the facet request.
-     */
-    facets?: FacetsRequestModel;
-    /**
-     * Pagination parameters for the returned products.
-     */
-    pagination?: PaginatedModel;
-    /**
-     * Determines the order in which to retrieve the results.
-     */
-    sort?: SortModel;
-    /**
-     * The URL used to retrieve the products listings.
-     */
-    url: string;
-}
-/**
- * @deprecated
- */
-export interface FacetResultModel {
-    facetId: string;
-    field: string;
-    fromAutoSelect: boolean;
-    indexScore: number;
-    mlScore: number;
-    moreValuesAvailable: boolean;
-    values: any[];
-}
-/**
- * @deprecated
- */
-export interface FacetResponseModel {
-    /**
-     * A list of facet results.
-     */
-    results: FacetResultModel[];
-}
-/**
- * @deprecated
- */
-export interface PaginationResultModel {
-    /**
-     * The number of elements.
-     */
-    totalCount: number;
-}
-/**
- * @deprecated
- */
-export interface ProductListingIdentityModel {
-    /**
-     * Associated catalog id.
-     */
-    catalogId: string;
-    /**
-     * The product listing unique id.
-     */
-    id: string;
-}
-/**
- * @deprecated
- */
-export interface ProductModel {
-    additionalFields: Map<string, any>;
-    childResults: ProductModel[];
-    clickUri: string;
-    ec_brand: string;
-    ec_category: string[];
-    ec_cogs: number;
-    ec_description: string;
-    ec_images: string[];
-    ec_in_stock: boolean;
-    ec_item_group_id: string;
-    ec_name: string;
-    ec_price: number;
-    ec_promo_price: number;
-    ec_rating: number;
-    ec_shortdesc: string;
-    ec_thumbnails: string[];
-    permanentid: string;
-    totalNumberOfChildResults: number;
-}
-/**
- * @deprecated
- */
-export interface ProductsResultModel {
-    /**
-     * The execution report.
-     */
-    executionReport: Map<string, any>;
-    /**
-     * The list of facet results.
-     */
-    facets: FacetResponseModel;
-    /**
-     * The number of total elements returned.
-     */
-    pagination: PaginationResultModel;
-    /**
-     * The product listing identity model.
-     */
-    productListing: ProductListingIdentityModel;
-    /**
-     * A list of products.
-     */
-    products: ProductModel[];
-    /**
-     * The response unique id.
-     */
-    responseId: string;
-}

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

@@ -1,2 +0,0 @@
-export * from './Product.js';
-export * from './ProductInterfaces.js';