ce-storefront 0.13.1 → 0.13.3

package/src/models/operations/listproducts.ts

@@ -23,13 +23,17 @@ export type ListProductsRequest = {
    */
   sortBy?: string | undefined;
   /**
-   * filter products by categories
+   * filter products by categories ids
    */
   categoryId?: Array<string> | undefined;
   /**
-   * use this param only if different pricing is configured as per customer group
+   * The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned.
    */
   customerGroupId?: string | undefined;
+  /**
+   * filter products by categories slugs
+   */
+  categorySlug?: Array<string> | undefined;
 };
 
 export type Content = {
@@ -60,11 +64,13 @@ export const ListProductsRequest$inboundSchema: z.ZodType<
   sort_by: z.string().optional(),
   category_id: z.array(z.string()).optional(),
   customer_group_id: z.string().optional(),
+  category_slug: z.array(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "sort_by": "sortBy",
     "category_id": "categoryId",
     "customer_group_id": "customerGroupId",
+    "category_slug": "categorySlug",
   });
 });
 
@@ -75,6 +81,7 @@ export type ListProductsRequest$Outbound = {
   sort_by?: string | undefined;
   category_id?: Array<string> | undefined;
   customer_group_id?: string | undefined;
+  category_slug?: Array<string> | undefined;
 };
 
 /** @internal */
@@ -88,11 +95,13 @@ export const ListProductsRequest$outboundSchema: z.ZodType<
   sortBy: z.string().optional(),
   categoryId: z.array(z.string()).optional(),
   customerGroupId: z.string().optional(),
+  categorySlug: z.array(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     sortBy: "sort_by",
     categoryId: "category_id",
     customerGroupId: "customer_group_id",
+    categorySlug: "category_slug",
   });
 });
 

package/src/models/operations/listproductvariants.ts

@@ -10,14 +10,14 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListProductVariantsRequest = {
-  /**
-   * use this param only if different pricing is configured as per customer group
-   */
-  customerGroupId?: string | undefined;
   /**
    * ID of a particular product
    */
   productId: string;
+  /**
+   * The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned.
+   */
+  customerGroupId?: string | undefined;
 };
 
 export type ListProductVariantsContent = {
@@ -39,19 +39,19 @@ export const ListProductVariantsRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  customer_group_id: z.string().optional(),
   product_id: z.string(),
+  customer_group_id: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    "customer_group_id": "customerGroupId",
     "product_id": "productId",
+    "customer_group_id": "customerGroupId",
   });
 });
 
 /** @internal */
 export type ListProductVariantsRequest$Outbound = {
-  customer_group_id?: string | undefined;
   product_id: string;
+  customer_group_id?: string | undefined;
 };
 
 /** @internal */
@@ -60,12 +60,12 @@ export const ListProductVariantsRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListProductVariantsRequest
 > = z.object({
-  customerGroupId: z.string().optional(),
   productId: z.string(),
+  customerGroupId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    customerGroupId: "customer_group_id",
     productId: "product_id",
+    customerGroupId: "customer_group_id",
   });
 });
 

package/src/models/operations/listsimilarproducts.ts

@@ -26,6 +26,10 @@ export type ListSimilarProductsRequest = {
    * json to sort records
    */
   sortBy?: string | undefined;
+  /**
+   * The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned.
+   */
+  customerGroupId?: string | undefined;
 };
 
 export type ListSimilarProductsContent = {
@@ -55,10 +59,12 @@ export const ListSimilarProductsRequest$inboundSchema: z.ZodType<
   page: z.number().int().optional(),
   limit: z.number().int().optional(),
   sort_by: z.string().optional(),
+  customer_group_id: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "product_id": "productId",
     "sort_by": "sortBy",
+    "customer_group_id": "customerGroupId",
   });
 });
 
@@ -68,6 +74,7 @@ export type ListSimilarProductsRequest$Outbound = {
   page?: number | undefined;
   limit?: number | undefined;
   sort_by?: string | undefined;
+  customer_group_id?: string | undefined;
 };
 
 /** @internal */
@@ -80,10 +87,12 @@ export const ListSimilarProductsRequest$outboundSchema: z.ZodType<
   page: z.number().int().optional(),
   limit: z.number().int().optional(),
   sortBy: z.string().optional(),
+  customerGroupId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     productId: "product_id",
     sortBy: "sort_by",
+    customerGroupId: "customer_group_id",
   });
 });
 

package/src/models/operations/listskus.ts

@@ -26,14 +26,14 @@ export type ListSkusRequest = {
    * filter sku by categories
    */
   categoryId?: Array<string> | undefined;
-  /**
-   * use this param only if different pricing is configured as per customer group
-   */
-  customerGroupId?: string | undefined;
   /**
    * array of sku
    */
   sku?: Array<string> | undefined;
+  /**
+   * The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned.
+   */
+  customerGroupId?: string | undefined;
 };
 
 export type ListSkusContent = {
@@ -63,8 +63,8 @@ export const ListSkusRequest$inboundSchema: z.ZodType<
   limit: z.number().int().optional(),
   sort_by: z.string().optional(),
   category_id: z.array(z.string()).optional(),
-  customer_group_id: z.string().optional(),
   sku: z.array(z.string()).optional(),
+  customer_group_id: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "sort_by": "sortBy",
@@ -79,8 +79,8 @@ export type ListSkusRequest$Outbound = {
   limit?: number | undefined;
   sort_by?: string | undefined;
   category_id?: Array<string> | undefined;
-  customer_group_id?: string | undefined;
   sku?: Array<string> | undefined;
+  customer_group_id?: string | undefined;
 };
 
 /** @internal */
@@ -93,8 +93,8 @@ export const ListSkusRequest$outboundSchema: z.ZodType<
   limit: z.number().int().optional(),
   sortBy: z.string().optional(),
   categoryId: z.array(z.string()).optional(),
-  customerGroupId: z.string().optional(),
   sku: z.array(z.string()).optional(),
+  customerGroupId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     sortBy: "sort_by",

package/src/models/operations/listupsellproducts.ts

@@ -26,6 +26,10 @@ export type ListUpsellProductsRequest = {
    * json to sort records
    */
   sortBy?: string | undefined;
+  /**
+   * The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned.
+   */
+  customerGroupId?: string | undefined;
 };
 
 export type ListUpsellProductsContent = {
@@ -58,10 +62,12 @@ export const ListUpsellProductsRequest$inboundSchema: z.ZodType<
   page: z.number().int().optional(),
   limit: z.number().int().optional(),
   sort_by: z.string().optional(),
+  customer_group_id: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "product_id": "productId",
     "sort_by": "sortBy",
+    "customer_group_id": "customerGroupId",
   });
 });
 
@@ -71,6 +77,7 @@ export type ListUpsellProductsRequest$Outbound = {
   page?: number | undefined;
   limit?: number | undefined;
   sort_by?: string | undefined;
+  customer_group_id?: string | undefined;
 };
 
 /** @internal */
@@ -83,10 +90,12 @@ export const ListUpsellProductsRequest$outboundSchema: z.ZodType<
   page: z.number().int().optional(),
   limit: z.number().int().optional(),
   sortBy: z.string().optional(),
+  customerGroupId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     productId: "product_id",
     sortBy: "sort_by",
+    customerGroupId: "customer_group_id",
   });
 });
 

package/src/sdk/catalog.ts

@@ -57,7 +57,7 @@ export class Catalog extends ClientSDK {
    * Retrieve a product detail
    *
    * @remarks
-   * Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Commerce Engine will return the corresponding product information.
+   * Retrieves the details of an existing product. Supply either the unique product ID or the unique slug, and Commerce Engine will return the corresponding product information.
    */
   async getProductDetail(
     request: operations.GetProductDetailRequest,