ce-storefront 0.12.5 → 0.13.1

package/src/models/components/appliedcoupon.ts

@@ -0,0 +1,139 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 CouponType = {
+  Discount: "discount",
+  FreeGoods: "free-goods",
+  FixedPrice: "fixed-price",
+  FreeShipping: "free-shipping",
+  BuyXGetY: "buy-x-get-y",
+  VolumeBased: "volume-based",
+  AcceleratedRewards: "accelerated-rewards",
+} as const;
+export type CouponType = ClosedEnum<typeof CouponType>;
+
+/**
+ * Details about an active coupon applied to a cart/order
+ */
+export type AppliedCoupon = {
+  couponId: string;
+  couponType: CouponType;
+  savings: number;
+  productId: string | null;
+  variantId: string | null;
+  productName: string | null;
+  variantName: string | null;
+};
+
+/** @internal */
+export const CouponType$inboundSchema: z.ZodNativeEnum<typeof CouponType> = z
+  .nativeEnum(CouponType);
+
+/** @internal */
+export const CouponType$outboundSchema: z.ZodNativeEnum<typeof CouponType> =
+  CouponType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CouponType$ {
+  /** @deprecated use `CouponType$inboundSchema` instead. */
+  export const inboundSchema = CouponType$inboundSchema;
+  /** @deprecated use `CouponType$outboundSchema` instead. */
+  export const outboundSchema = CouponType$outboundSchema;
+}
+
+/** @internal */
+export const AppliedCoupon$inboundSchema: z.ZodType<
+  AppliedCoupon,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coupon_id: z.string(),
+  coupon_type: CouponType$inboundSchema,
+  savings: z.number(),
+  product_id: z.nullable(z.string()),
+  variant_id: z.nullable(z.string()),
+  product_name: z.nullable(z.string()),
+  variant_name: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "coupon_id": "couponId",
+    "coupon_type": "couponType",
+    "product_id": "productId",
+    "variant_id": "variantId",
+    "product_name": "productName",
+    "variant_name": "variantName",
+  });
+});
+
+/** @internal */
+export type AppliedCoupon$Outbound = {
+  coupon_id: string;
+  coupon_type: string;
+  savings: number;
+  product_id: string | null;
+  variant_id: string | null;
+  product_name: string | null;
+  variant_name: string | null;
+};
+
+/** @internal */
+export const AppliedCoupon$outboundSchema: z.ZodType<
+  AppliedCoupon$Outbound,
+  z.ZodTypeDef,
+  AppliedCoupon
+> = z.object({
+  couponId: z.string(),
+  couponType: CouponType$outboundSchema,
+  savings: z.number(),
+  productId: z.nullable(z.string()),
+  variantId: z.nullable(z.string()),
+  productName: z.nullable(z.string()),
+  variantName: z.nullable(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    couponId: "coupon_id",
+    couponType: "coupon_type",
+    productId: "product_id",
+    variantId: "variant_id",
+    productName: "product_name",
+    variantName: "variant_name",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AppliedCoupon$ {
+  /** @deprecated use `AppliedCoupon$inboundSchema` instead. */
+  export const inboundSchema = AppliedCoupon$inboundSchema;
+  /** @deprecated use `AppliedCoupon$outboundSchema` instead. */
+  export const outboundSchema = AppliedCoupon$outboundSchema;
+  /** @deprecated use `AppliedCoupon$Outbound` instead. */
+  export type Outbound = AppliedCoupon$Outbound;
+}
+
+export function appliedCouponToJSON(appliedCoupon: AppliedCoupon): string {
+  return JSON.stringify(AppliedCoupon$outboundSchema.parse(appliedCoupon));
+}
+
+export function appliedCouponFromJSON(
+  jsonString: string,
+): SafeParseResult<AppliedCoupon, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppliedCoupon$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppliedCoupon' from JSON`,
+  );
+}

package/src/models/components/appliedpromotion.ts

@@ -0,0 +1,155 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 AppliedPromotionPromotionType = {
+  Discount: "discount",
+  FreeGoods: "free-goods",
+  FreeShipping: "free-shipping",
+  BuyXGetY: "buy-x-get-y",
+  VolumeBased: "volume-based",
+} as const;
+export type AppliedPromotionPromotionType = ClosedEnum<
+  typeof AppliedPromotionPromotionType
+>;
+
+/**
+ * Details about an active promotion applied to a cart/order
+ */
+export type AppliedPromotion = {
+  promotionId: string;
+  promotionType: AppliedPromotionPromotionType;
+  savings: number;
+  productId: string | null;
+  variantId: string | null;
+  productName: string | null;
+  variantName: string | null;
+  appliedSequence: number;
+  scope: string;
+};
+
+/** @internal */
+export const AppliedPromotionPromotionType$inboundSchema: z.ZodNativeEnum<
+  typeof AppliedPromotionPromotionType
+> = z.nativeEnum(AppliedPromotionPromotionType);
+
+/** @internal */
+export const AppliedPromotionPromotionType$outboundSchema: z.ZodNativeEnum<
+  typeof AppliedPromotionPromotionType
+> = AppliedPromotionPromotionType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AppliedPromotionPromotionType$ {
+  /** @deprecated use `AppliedPromotionPromotionType$inboundSchema` instead. */
+  export const inboundSchema = AppliedPromotionPromotionType$inboundSchema;
+  /** @deprecated use `AppliedPromotionPromotionType$outboundSchema` instead. */
+  export const outboundSchema = AppliedPromotionPromotionType$outboundSchema;
+}
+
+/** @internal */
+export const AppliedPromotion$inboundSchema: z.ZodType<
+  AppliedPromotion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  promotion_id: z.string(),
+  promotion_type: AppliedPromotionPromotionType$inboundSchema,
+  savings: z.number(),
+  product_id: z.nullable(z.string()),
+  variant_id: z.nullable(z.string()),
+  product_name: z.nullable(z.string()),
+  variant_name: z.nullable(z.string()),
+  applied_sequence: z.number(),
+  scope: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "promotion_id": "promotionId",
+    "promotion_type": "promotionType",
+    "product_id": "productId",
+    "variant_id": "variantId",
+    "product_name": "productName",
+    "variant_name": "variantName",
+    "applied_sequence": "appliedSequence",
+  });
+});
+
+/** @internal */
+export type AppliedPromotion$Outbound = {
+  promotion_id: string;
+  promotion_type: string;
+  savings: number;
+  product_id: string | null;
+  variant_id: string | null;
+  product_name: string | null;
+  variant_name: string | null;
+  applied_sequence: number;
+  scope: string;
+};
+
+/** @internal */
+export const AppliedPromotion$outboundSchema: z.ZodType<
+  AppliedPromotion$Outbound,
+  z.ZodTypeDef,
+  AppliedPromotion
+> = z.object({
+  promotionId: z.string(),
+  promotionType: AppliedPromotionPromotionType$outboundSchema,
+  savings: z.number(),
+  productId: z.nullable(z.string()),
+  variantId: z.nullable(z.string()),
+  productName: z.nullable(z.string()),
+  variantName: z.nullable(z.string()),
+  appliedSequence: z.number(),
+  scope: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    promotionId: "promotion_id",
+    promotionType: "promotion_type",
+    productId: "product_id",
+    variantId: "variant_id",
+    productName: "product_name",
+    variantName: "variant_name",
+    appliedSequence: "applied_sequence",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AppliedPromotion$ {
+  /** @deprecated use `AppliedPromotion$inboundSchema` instead. */
+  export const inboundSchema = AppliedPromotion$inboundSchema;
+  /** @deprecated use `AppliedPromotion$outboundSchema` instead. */
+  export const outboundSchema = AppliedPromotion$outboundSchema;
+  /** @deprecated use `AppliedPromotion$Outbound` instead. */
+  export type Outbound = AppliedPromotion$Outbound;
+}
+
+export function appliedPromotionToJSON(
+  appliedPromotion: AppliedPromotion,
+): string {
+  return JSON.stringify(
+    AppliedPromotion$outboundSchema.parse(appliedPromotion),
+  );
+}
+
+export function appliedPromotionFromJSON(
+  jsonString: string,
+): SafeParseResult<AppliedPromotion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppliedPromotion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppliedPromotion' from JSON`,
+  );
+}

package/src/models/components/cart.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";
+import {
+  AppliedCoupon,
+  AppliedCoupon$inboundSchema,
+  AppliedCoupon$Outbound,
+  AppliedCoupon$outboundSchema,
+} from "./appliedcoupon.js";
+import {
+  AppliedPromotion,
+  AppliedPromotion$inboundSchema,
+  AppliedPromotion$Outbound,
+  AppliedPromotion$outboundSchema,
+} from "./appliedpromotion.js";
 import {
   CartItem,
   CartItem$inboundSchema,
@@ -27,46 +38,6 @@ import {
   CustomerAddress$outboundSchema,
 } from "./customeraddress.js";
 
-export const PromotionType = {
-  Discount: "discount",
-  FreeGoods: "free-goods",
-  FreeShipping: "free-shipping",
-  BuyXGetY: "buy-x-get-y",
-  VolumeBased: "volume-based",
-} as const;
-export type PromotionType = ClosedEnum<typeof PromotionType>;
-
-export type AppliedPromotions = {
-  promotionId: string;
-  promotionType: PromotionType;
-  savings: number;
-  productId: string | null;
-  productName: string | null;
-  variantId: string | null;
-  variantName: string | null;
-};
-
-export const CouponType = {
-  Discount: "discount",
-  FreeGoods: "free-goods",
-  FixedPrice: "fixed-price",
-  FreeShipping: "free-shipping",
-  BuyXGetY: "buy-x-get-y",
-  VolumeBased: "volume-based",
-  AcceleratedRewards: "accelerated-rewards",
-} as const;
-export type CouponType = ClosedEnum<typeof CouponType>;
-
-export type AppliedCoupons = {
-  couponId: string;
-  couponType: CouponType;
-  savings: number;
-  productId: string | null;
-  productName: string | null;
-  variantId: string | null;
-  variantName: string | null;
-};
-
 /**
  * This cart model is structured to capture a wide range of details, facilitating accurate representation and management of user shopping carts in an e-commerce platform.
  */
@@ -205,233 +176,17 @@ export type Cart = {
   /**
    * Information about the promotional offers that have been applied to the cart.
    */
-  appliedPromotions: Array<AppliedPromotions>;
+  appliedPromotions: Array<AppliedPromotion>;
   /**
    * This key provides details about the savings in cart after coupon have been applied to the cart.
    */
-  appliedCoupons: Array<AppliedCoupons>;
+  appliedCoupons: Array<AppliedCoupon>;
   promotionSavings: number;
   couponSavings: number;
   otherSavings: number;
   totalSavings: number;
 };
 
-/** @internal */
-export const PromotionType$inboundSchema: z.ZodNativeEnum<
-  typeof PromotionType
-> = z.nativeEnum(PromotionType);
-
-/** @internal */
-export const PromotionType$outboundSchema: z.ZodNativeEnum<
-  typeof PromotionType
-> = PromotionType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PromotionType$ {
-  /** @deprecated use `PromotionType$inboundSchema` instead. */
-  export const inboundSchema = PromotionType$inboundSchema;
-  /** @deprecated use `PromotionType$outboundSchema` instead. */
-  export const outboundSchema = PromotionType$outboundSchema;
-}
-
-/** @internal */
-export const AppliedPromotions$inboundSchema: z.ZodType<
-  AppliedPromotions,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  promotion_id: z.string(),
-  promotion_type: PromotionType$inboundSchema,
-  savings: z.number(),
-  product_id: z.nullable(z.string()),
-  product_name: z.nullable(z.string()),
-  variant_id: z.nullable(z.string()),
-  variant_name: z.nullable(z.string()),
-}).transform((v) => {
-  return remap$(v, {
-    "promotion_id": "promotionId",
-    "promotion_type": "promotionType",
-    "product_id": "productId",
-    "product_name": "productName",
-    "variant_id": "variantId",
-    "variant_name": "variantName",
-  });
-});
-
-/** @internal */
-export type AppliedPromotions$Outbound = {
-  promotion_id: string;
-  promotion_type: string;
-  savings: number;
-  product_id: string | null;
-  product_name: string | null;
-  variant_id: string | null;
-  variant_name: string | null;
-};
-
-/** @internal */
-export const AppliedPromotions$outboundSchema: z.ZodType<
-  AppliedPromotions$Outbound,
-  z.ZodTypeDef,
-  AppliedPromotions
-> = z.object({
-  promotionId: z.string(),
-  promotionType: PromotionType$outboundSchema,
-  savings: z.number(),
-  productId: z.nullable(z.string()),
-  productName: z.nullable(z.string()),
-  variantId: z.nullable(z.string()),
-  variantName: z.nullable(z.string()),
-}).transform((v) => {
-  return remap$(v, {
-    promotionId: "promotion_id",
-    promotionType: "promotion_type",
-    productId: "product_id",
-    productName: "product_name",
-    variantId: "variant_id",
-    variantName: "variant_name",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace AppliedPromotions$ {
-  /** @deprecated use `AppliedPromotions$inboundSchema` instead. */
-  export const inboundSchema = AppliedPromotions$inboundSchema;
-  /** @deprecated use `AppliedPromotions$outboundSchema` instead. */
-  export const outboundSchema = AppliedPromotions$outboundSchema;
-  /** @deprecated use `AppliedPromotions$Outbound` instead. */
-  export type Outbound = AppliedPromotions$Outbound;
-}
-
-export function appliedPromotionsToJSON(
-  appliedPromotions: AppliedPromotions,
-): string {
-  return JSON.stringify(
-    AppliedPromotions$outboundSchema.parse(appliedPromotions),
-  );
-}
-
-export function appliedPromotionsFromJSON(
-  jsonString: string,
-): SafeParseResult<AppliedPromotions, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AppliedPromotions$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AppliedPromotions' from JSON`,
-  );
-}
-
-/** @internal */
-export const CouponType$inboundSchema: z.ZodNativeEnum<typeof CouponType> = z
-  .nativeEnum(CouponType);
-
-/** @internal */
-export const CouponType$outboundSchema: z.ZodNativeEnum<typeof CouponType> =
-  CouponType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace CouponType$ {
-  /** @deprecated use `CouponType$inboundSchema` instead. */
-  export const inboundSchema = CouponType$inboundSchema;
-  /** @deprecated use `CouponType$outboundSchema` instead. */
-  export const outboundSchema = CouponType$outboundSchema;
-}
-
-/** @internal */
-export const AppliedCoupons$inboundSchema: z.ZodType<
-  AppliedCoupons,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  coupon_id: z.string(),
-  coupon_type: CouponType$inboundSchema,
-  savings: z.number(),
-  product_id: z.nullable(z.string()),
-  product_name: z.nullable(z.string()),
-  variant_id: z.nullable(z.string()),
-  variant_name: z.nullable(z.string()),
-}).transform((v) => {
-  return remap$(v, {
-    "coupon_id": "couponId",
-    "coupon_type": "couponType",
-    "product_id": "productId",
-    "product_name": "productName",
-    "variant_id": "variantId",
-    "variant_name": "variantName",
-  });
-});
-
-/** @internal */
-export type AppliedCoupons$Outbound = {
-  coupon_id: string;
-  coupon_type: string;
-  savings: number;
-  product_id: string | null;
-  product_name: string | null;
-  variant_id: string | null;
-  variant_name: string | null;
-};
-
-/** @internal */
-export const AppliedCoupons$outboundSchema: z.ZodType<
-  AppliedCoupons$Outbound,
-  z.ZodTypeDef,
-  AppliedCoupons
-> = z.object({
-  couponId: z.string(),
-  couponType: CouponType$outboundSchema,
-  savings: z.number(),
-  productId: z.nullable(z.string()),
-  productName: z.nullable(z.string()),
-  variantId: z.nullable(z.string()),
-  variantName: z.nullable(z.string()),
-}).transform((v) => {
-  return remap$(v, {
-    couponId: "coupon_id",
-    couponType: "coupon_type",
-    productId: "product_id",
-    productName: "product_name",
-    variantId: "variant_id",
-    variantName: "variant_name",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace AppliedCoupons$ {
-  /** @deprecated use `AppliedCoupons$inboundSchema` instead. */
-  export const inboundSchema = AppliedCoupons$inboundSchema;
-  /** @deprecated use `AppliedCoupons$outboundSchema` instead. */
-  export const outboundSchema = AppliedCoupons$outboundSchema;
-  /** @deprecated use `AppliedCoupons$Outbound` instead. */
-  export type Outbound = AppliedCoupons$Outbound;
-}
-
-export function appliedCouponsToJSON(appliedCoupons: AppliedCoupons): string {
-  return JSON.stringify(AppliedCoupons$outboundSchema.parse(appliedCoupons));
-}
-
-export function appliedCouponsFromJSON(
-  jsonString: string,
-): SafeParseResult<AppliedCoupons, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AppliedCoupons$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AppliedCoupons' from JSON`,
-  );
-}
-
 /** @internal */
 export const Cart$inboundSchema: z.ZodType<Cart, z.ZodTypeDef, unknown> = z
   .object({
@@ -476,8 +231,8 @@ export const Cart$inboundSchema: z.ZodType<Cart, z.ZodTypeDef, unknown> = z
     expires_at: z.nullable(
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ),
-    applied_promotions: z.array(z.lazy(() => AppliedPromotions$inboundSchema)),
-    applied_coupons: z.array(z.lazy(() => AppliedCoupons$inboundSchema)),
+    applied_promotions: z.array(AppliedPromotion$inboundSchema),
+    applied_coupons: z.array(AppliedCoupon$inboundSchema),
     promotion_savings: z.number(),
     coupon_savings: z.number(),
     other_savings: z.number(),
@@ -568,8 +323,8 @@ export type Cart$Outbound = {
   currency: Currency$Outbound;
   metadata: { [k: string]: string } | null;
   expires_at: string | null;
-  applied_promotions: Array<AppliedPromotions$Outbound>;
-  applied_coupons: Array<AppliedCoupons$Outbound>;
+  applied_promotions: Array<AppliedPromotion$Outbound>;
+  applied_coupons: Array<AppliedCoupon$Outbound>;
   promotion_savings: number;
   coupon_savings: number;
   other_savings: number;
@@ -618,8 +373,8 @@ export const Cart$outboundSchema: z.ZodType<Cart$Outbound, z.ZodTypeDef, Cart> =
     currency: Currency$outboundSchema,
     metadata: z.nullable(z.record(z.string())),
     expiresAt: z.nullable(z.date().transform(v => v.toISOString())),
-    appliedPromotions: z.array(z.lazy(() => AppliedPromotions$outboundSchema)),
-    appliedCoupons: z.array(z.lazy(() => AppliedCoupons$outboundSchema)),
+    appliedPromotions: z.array(AppliedPromotion$outboundSchema),
+    appliedCoupons: z.array(AppliedCoupon$outboundSchema),
     promotionSavings: z.number(),
     couponSavings: z.number(),
     otherSavings: z.number(),

package/src/models/components/discountbasedpromotion.ts

@@ -9,6 +9,14 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+export const PromotionType = {
+  Discount: "discount",
+  VolumeBased: "volume-based",
+  FixedPrice: "fixed-price",
+  FreeGoods: "free-goods",
+} as const;
+export type PromotionType = ClosedEnum<typeof PromotionType>;
+
 export const DiscountType = {
   Percentage: "percentage",
   FixedAmount: "fixed-amount",
@@ -28,6 +36,27 @@ export type DiscountBasedPromotion = {
   discountFixedAmount?: number | undefined;
 };
 
+/** @internal */
+export const PromotionType$inboundSchema: z.ZodNativeEnum<
+  typeof PromotionType
+> = z.nativeEnum(PromotionType);
+
+/** @internal */
+export const PromotionType$outboundSchema: z.ZodNativeEnum<
+  typeof PromotionType
+> = PromotionType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PromotionType$ {
+  /** @deprecated use `PromotionType$inboundSchema` instead. */
+  export const inboundSchema = PromotionType$inboundSchema;
+  /** @deprecated use `PromotionType$outboundSchema` instead. */
+  export const outboundSchema = PromotionType$outboundSchema;
+}
+
 /** @internal */
 export const DiscountType$inboundSchema: z.ZodNativeEnum<typeof DiscountType> =
   z.nativeEnum(DiscountType);
@@ -80,7 +109,7 @@ export const DiscountBasedPromotion$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   DiscountBasedPromotion
 > = z.object({
-  promotionType: z.literal("discount").default("discount" as const),
+  promotionType: z.literal("discount").default("discount"),
   discountType: DiscountType$outboundSchema,
   discountPercent: z.number().optional(),
   discountFixedAmount: z.number().int().optional(),