feat(MHUB-1665): mark as deprecated product and product listing inter…

…faces & methods (#847) * feat: mark as deprecated product and product listing interfaces * feat: deprecate products and product listing methods * feat: add high level deprecation
coveo · Aug 15, 2024 · b3dc1bc · b3dc1bc
1 parent 4d1b923
commit b3dc1bc
Show file tree

Hide file tree

Showing 6 changed files with 119 additions and 0 deletions.
diff --git a/src/resources/Catalogs/ProductListing.ts b/src/resources/Catalogs/ProductListing.ts
@@ -8,47 +8,71 @@ import {
     CatalogProductListingsGroupModel,
 } from './ProductListingInterfaces.js';
 
+/**
+ * @deprecated
+ */
 export default class ProductListing extends Resource {
     static baseCatalogsUrl = `/rest/organizations/${API.orgPlaceholder}/catalogs`;
     static baseProductListingsUrl = `/rest/organizations/${API.orgPlaceholder}/productlistings`;
 
+    /**
+     * @deprecated
+     */
     list(catalogId: string, options?: ProductListingsListOptions) {
         const normalizedOptions = normalizePaginatedOptions(options);
         return this.api.get<PageModel<ProductListingModel>>(
             this.buildPath(`${ProductListing.baseCatalogsUrl}/${catalogId}/productlistings`, normalizedOptions),
         );
     }
 
+    /**
+     * @deprecated
+     */
     create(catalogId: string, model: New<ProductListingModel>) {
         return this.api.post<ProductListingModel>(
             `${ProductListing.baseCatalogsUrl}/${catalogId}/productlistings`,
             model,
         );
     }
 
+    /**
+     * @deprecated
+     */
     delete(catalogId: string, productListingId: string) {
         return this.api.delete(`${ProductListing.baseCatalogsUrl}/${catalogId}/productlistings/${productListingId}`);
     }
 
+    /**
+     * @deprecated
+     */
     get(catalogId: string, productListingId: string) {
         return this.api.get<ProductListingModel>(
             `${ProductListing.baseCatalogsUrl}/${catalogId}/productlistings/${productListingId}`,
         );
     }
 
+    /**
+     * @deprecated
+     */
     update(catalogId: string, model: ProductListingModel) {
         return this.api.put<ProductListingModel>(
             `${ProductListing.baseCatalogsUrl}/${catalogId}/productlistings/${model.id}`,
             model,
         );
     }
 
+    /**
+     * @deprecated
+     */
     getByCatalog() {
         return this.api.get<PageModel<CatalogProductListingsGroupModel>>(
             `${ProductListing.baseProductListingsUrl}/catalogs`,
         );
     }
 
+    /**
+     * @deprecated
+     */
     getUrls() {
         return this.api.get<string[]>(`${ProductListing.baseProductListingsUrl}/urls`);
     }

diff --git a/src/resources/Catalogs/ProductListingConfiguration.ts b/src/resources/Catalogs/ProductListingConfiguration.ts
@@ -7,9 +7,15 @@ import {
     ProductListingConfigurationOptions,
 } from './ProductListingConfigurationInterfaces.js';
 
+/**
+ * @deprecated
+ */
 export default class ProductListingConfiguration extends Resource {
     static baseUrl = `/rest/organizations/${API.orgPlaceholder}/catalogs`;
 
+    /**
+     * @deprecated
+     */
     list(catalogId: string, productListingId: string, options?: ProductListingConfigurationOptions) {
         const normalizedOptions = normalizePaginatedOptions(options);
         return this.api.get<PageModel<ProductListingConfigurationModel>>(
@@ -19,25 +25,38 @@ export default class ProductListingConfiguration extends Resource {
             ),
         );
     }
+
+    /**
+     * @deprecated
+     */
     create(catalogId: string, productListingId: string, rankingConfiguration: New<ProductListingConfigurationModel>) {
         return this.api.post(
             `${ProductListingConfiguration.baseUrl}/${catalogId}/productlistings/${productListingId}/configurations`,
             rankingConfiguration,
         );
     }
 
+    /**
+     * @deprecated
+     */
     delete(catalogId: string, productListingId: string, productListingConfigurationId: string) {
         return this.api.delete(
             `${ProductListingConfiguration.baseUrl}/${catalogId}/productlistings/${productListingId}/configurations/${productListingConfigurationId}`,
         );
     }
 
+    /**
+     * @deprecated
+     */
     get(catalogId: string, productListingId: string, productListingConfigurationId: string) {
         return this.api.get<ProductListingConfigurationModel>(
             `${ProductListingConfiguration.baseUrl}/${catalogId}/productlistings/${productListingId}/configurations/${productListingConfigurationId}`,
         );
     }
 
+    /**
+     * @deprecated
+     */
     update(
         catalogId: string,
         productListingId: string,

diff --git a/src/resources/Catalogs/ProductListingConfigurationInterfaces.ts b/src/resources/Catalogs/ProductListingConfigurationInterfaces.ts
@@ -2,8 +2,14 @@ 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.
@@ -15,6 +21,9 @@ export interface ProductListingConfigurationModel {
     rankingConfigurations: RankingConfiguration[];
 }
 
+/**
+ * @deprecated
+ */
 export interface RankingConfiguration {
     /**
      * The name of the RankingConfiguration.
@@ -38,6 +47,9 @@ export interface RankingConfiguration {
     value: number;
 }
 
+/**
+ * @deprecated
+ */
 export enum RankingTypeEnum {
     BOOST = 'BOOST',
     BURY = 'BURY',

diff --git a/src/resources/Catalogs/ProductListingInterfaces.ts b/src/resources/Catalogs/ProductListingInterfaces.ts
@@ -2,6 +2,9 @@ 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> {
@@ -30,6 +33,9 @@ type FieldValueModel =
     | FieldValueModelGeneric<FieldValueType.ARRAY>
     | FieldValueModelGeneric<FieldValueType.HIERARCHIC_MULTI_VALUE>;
 
+/**
+ * @deprecated
+ */
 export interface QueryFilterModel {
     /**
      * The field name.
@@ -45,11 +51,17 @@ export interface QueryFilterModel {
     value: FieldValueModel;
 }
 
+/**
+ * @deprecated
+ */
 export interface ProductListingMetricsModel {
     lastNumberOfProducts?: number;
     lastQueried: string;
 }
 
+/**
+ * @deprecated
+ */
 export interface ProductListingModel {
     /**
      * The list of exclusion filters.
@@ -77,6 +89,9 @@ export interface ProductListingModel {
     metrics?: ProductListingMetricsModel;
 }
 
+/**
+ * @deprecated
+ */
 export interface CatalogProductListingsGroupModel {
     /**
      * The unique identifier of the catalog.

diff --git a/src/resources/Products/Product.ts b/src/resources/Products/Product.ts
@@ -6,6 +6,9 @@ import {ProductsRequestModel, ProductsResultModel} from './ProductInterfaces.js'
 export default class Products extends Resource {
     static baseUrl = `/rest/organizations/${API.orgPlaceholder}/commerce/v1/products`;
 
+    /**
+     * @deprecated
+     */
     get(productsRequest: New<ProductsRequestModel>, refreshCache = false) {
         return this.api.post<ProductsResultModel>(
             this.buildPath(`${Products.baseUrl}/listing`, {refreshCache: refreshCache}),

diff --git a/src/resources/Products/ProductInterfaces.ts b/src/resources/Products/ProductInterfaces.ts
@@ -1,9 +1,15 @@
 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.
@@ -15,6 +21,9 @@ export interface AdvancedParametersModel {
     viewAllContent?: boolean;
 }
 
+/**
+ * @deprecated
+ */
 export interface FacetRequestOptions {
     /**
      * Whether to take into account the scores generated by the index when reordering facets.
@@ -26,6 +35,9 @@ export interface FacetRequestOptions {
     freezeFacetOrder?: boolean;
 }
 
+/**
+ * @deprecated
+ */
 export interface FacetRequestItem {
     /**
      * The values displayed by the facet in the search interface at the moment of the request.
@@ -61,6 +73,9 @@ export interface FacetRequestItem {
     sortCriteria?: ProductsFacetRequestSortType;
 }
 
+/**
+ * @deprecated
+ */
 export interface FacetsRequestModel {
     /**
      * The facet options to add to the request.
@@ -72,6 +87,9 @@ export interface FacetsRequestModel {
     requests: FacetRequestItem[];
 }
 
+/**
+ * @deprecated
+ */
 export interface PaginatedModel {
     /**
      * The number of elements to list per page.
@@ -83,6 +101,9 @@ export interface PaginatedModel {
     page?: number;
 }
 
+/**
+ * @deprecated
+ */
 export interface SortByFields {
     /**
      * The name of the field.
@@ -94,6 +115,9 @@ export interface SortByFields {
     direction: SortingOrder;
 }
 
+/**
+ * @deprecated
+ */
 export interface SortModel {
     /**
      * The name of the field to sort by.
@@ -105,6 +129,10 @@ export interface SortModel {
     fields?: SortByFields[];
 }
 
+/**
+ * @deprecated
+ */
+
 export interface ProductsRequestModel {
     /**
      * Additional fields allow you to collect additional information, besides the standard data.
@@ -140,6 +168,9 @@ export interface ProductsRequestModel {
     url: string;
 }
 
+/**
+ * @deprecated
+ */
 export interface FacetResultModel {
     facetId: string;
     field: string;
@@ -150,20 +181,29 @@ export interface FacetResultModel {
     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.
@@ -175,6 +215,9 @@ export interface ProductListingIdentityModel {
     id: string;
 }
 
+/**
+ * @deprecated
+ */
 export interface ProductModel {
     additionalFields: Map<string, any>;
     childResults: ProductModel[];
@@ -196,6 +239,9 @@ export interface ProductModel {
     totalNumberOfChildResults: number;
 }
 
+/**
+ * @deprecated
+ */
 export interface ProductsResultModel {
     /**
      * The execution report.