ce-storefront 0.13.0 → 0.13.2

package/src/models/components/volumebasedpromotion.ts

@@ -5,9 +5,20 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+export const VolumeBasedPromotionPromotionType = {
+  Discount: "discount",
+  VolumeBased: "volume-based",
+  FixedPrice: "fixed-price",
+  FreeGoods: "free-goods",
+} as const;
+export type VolumeBasedPromotionPromotionType = ClosedEnum<
+  typeof VolumeBasedPromotionPromotionType
+>;
+
 export type Slabs = {
   /**
    * The minimum quantity required to qualify for the discount.
@@ -20,10 +31,32 @@ export type Slabs = {
 };
 
 export type VolumeBasedPromotion = {
-  promotionType?: "discount" | undefined;
+  promotionType?: "volume-based" | undefined;
   slabs: Array<Slabs>;
 };
 
+/** @internal */
+export const VolumeBasedPromotionPromotionType$inboundSchema: z.ZodNativeEnum<
+  typeof VolumeBasedPromotionPromotionType
+> = z.nativeEnum(VolumeBasedPromotionPromotionType);
+
+/** @internal */
+export const VolumeBasedPromotionPromotionType$outboundSchema: z.ZodNativeEnum<
+  typeof VolumeBasedPromotionPromotionType
+> = VolumeBasedPromotionPromotionType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VolumeBasedPromotionPromotionType$ {
+  /** @deprecated use `VolumeBasedPromotionPromotionType$inboundSchema` instead. */
+  export const inboundSchema = VolumeBasedPromotionPromotionType$inboundSchema;
+  /** @deprecated use `VolumeBasedPromotionPromotionType$outboundSchema` instead. */
+  export const outboundSchema =
+    VolumeBasedPromotionPromotionType$outboundSchema;
+}
+
 /** @internal */
 export const Slabs$inboundSchema: z.ZodType<Slabs, z.ZodTypeDef, unknown> = z
   .object({
@@ -90,7 +123,7 @@ export const VolumeBasedPromotion$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  promotion_type: z.literal("discount").optional(),
+  promotion_type: z.literal("volume-based").optional(),
   slabs: z.array(z.lazy(() => Slabs$inboundSchema)),
 }).transform((v) => {
   return remap$(v, {
@@ -100,7 +133,7 @@ export const VolumeBasedPromotion$inboundSchema: z.ZodType<
 
 /** @internal */
 export type VolumeBasedPromotion$Outbound = {
-  promotion_type: "discount";
+  promotion_type: "volume-based";
   slabs: Array<Slabs$Outbound>;
 };
 
@@ -110,7 +143,7 @@ export const VolumeBasedPromotion$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   VolumeBasedPromotion
 > = z.object({
-  promotionType: z.literal("discount").default("discount" as const),
+  promotionType: z.literal("volume-based").default("volume-based"),
   slabs: z.array(z.lazy(() => Slabs$outboundSchema)),
 }).transform((v) => {
   return remap$(v, {

package/src/models/errors/ceerror.ts

@@ -3,22 +3,37 @@
  */
 
 export class CeError extends Error {
+  /**
+   * HTTP status code
+   */
   public readonly statusCode: number;
+  /**
+   * HTTP content type
+   */
   public readonly contentType: string;
+  /**
+   * HTTP body
+   */
+  public readonly body: string;
+  /**
+   * Raw response
+   */
+  public readonly rawResponse: Response;
 
   constructor(
     message: string,
-    public readonly rawResponse: Response,
-    public readonly body: string = "",
+    rawResponse: Response,
+    body: string = "",
   ) {
     const statusCode = rawResponse.status;
     const contentType = rawResponse.headers.get("content-type") || "";
     const bodyString = body.length > 0 ? `\n${body}` : "";
-
     super(
       `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
     );
 
+    this.body = body;
+    this.rawResponse = rawResponse;
     this.statusCode = statusCode;
     this.contentType = contentType;
 

package/src/models/operations/getproductdetail.ts

@@ -10,14 +10,14 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetProductDetailRequest = {
-  /**
-   * use this param only if different pricing is configured as per customer group
-   */
-  customerGroupId?: string | undefined;
   /**
    * id of a particular product
    */
   productId?: 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 GetProductDetailContent = {
@@ -39,19 +39,19 @@ export const GetProductDetailRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  customer_group_id: z.string().optional(),
   product_id: z.string().default("1"),
+  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 GetProductDetailRequest$Outbound = {
-  customer_group_id?: string | undefined;
   product_id: string;
+  customer_group_id?: string | undefined;
 };
 
 /** @internal */
@@ -60,12 +60,12 @@ export const GetProductDetailRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetProductDetailRequest
 > = z.object({
-  customerGroupId: z.string().optional(),
   productId: z.string().default("1"),
+  customerGroupId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    customerGroupId: "customer_group_id",
     productId: "product_id",
+    customerGroupId: "customer_group_id",
   });
 });
 

package/src/models/operations/getvariantdetail.ts

@@ -10,10 +10,6 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetVariantDetailRequest = {
-  /**
-   * use this param only if different pricing is configured as per customer group
-   */
-  customerGroupId?: string | undefined;
   /**
    * product id
    */
@@ -22,6 +18,10 @@ export type GetVariantDetailRequest = {
    * variant id
    */
   variantId: 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 GetVariantDetailContent = {
@@ -43,22 +43,22 @@ export const GetVariantDetailRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  customer_group_id: z.string().optional(),
   product_id: z.string(),
   variant_id: z.string(),
+  customer_group_id: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    "customer_group_id": "customerGroupId",
     "product_id": "productId",
     "variant_id": "variantId",
+    "customer_group_id": "customerGroupId",
   });
 });
 
 /** @internal */
 export type GetVariantDetailRequest$Outbound = {
-  customer_group_id?: string | undefined;
   product_id: string;
   variant_id: string;
+  customer_group_id?: string | undefined;
 };
 
 /** @internal */
@@ -67,14 +67,14 @@ export const GetVariantDetailRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetVariantDetailRequest
 > = z.object({
-  customerGroupId: z.string().optional(),
   productId: z.string(),
   variantId: z.string(),
+  customerGroupId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    customerGroupId: "customer_group_id",
     productId: "product_id",
     variantId: "variant_id",
+    customerGroupId: "customer_group_id",
   });
 });
 

package/src/models/operations/listcrosssellproducts.ts

@@ -26,6 +26,10 @@ export type ListCrosssellProductsRequest = {
    * 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 ListCrosssellProductsContent = {
@@ -55,10 +59,12 @@ export const ListCrosssellProductsRequest$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 ListCrosssellProductsRequest$Outbound = {
   page?: number | undefined;
   limit?: number | undefined;
   sort_by?: string | undefined;
+  customer_group_id?: string | undefined;
 };
 
 /** @internal */
@@ -80,10 +87,12 @@ export const ListCrosssellProductsRequest$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/listproducts.ts

@@ -27,7 +27,7 @@ export type ListProductsRequest = {
    */
   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;
 };

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",
   });
 });