ce-storefront 0.4.0 → 0.4.1

package/src/models/components/productbundleitem.ts

@@ -0,0 +1,329 @@
+/*
+ * 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";
+import {
+  AssociatedOption,
+  AssociatedOption$inboundSchema,
+  AssociatedOption$Outbound,
+  AssociatedOption$outboundSchema,
+} from "./associatedoption.js";
+import {
+  ProductAttribute,
+  ProductAttribute$inboundSchema,
+  ProductAttribute$Outbound,
+  ProductAttribute$outboundSchema,
+} from "./productattribute.js";
+import {
+  ProductImage,
+  ProductImage$inboundSchema,
+  ProductImage$Outbound,
+  ProductImage$outboundSchema,
+} from "./productimage.js";
+import {
+  ProductPricing,
+  ProductPricing$inboundSchema,
+  ProductPricing$Outbound,
+  ProductPricing$outboundSchema,
+} from "./productpricing.js";
+import {
+  ProductPromotion,
+  ProductPromotion$inboundSchema,
+  ProductPromotion$Outbound,
+  ProductPromotion$outboundSchema,
+} from "./productpromotion.js";
+import {
+  ProductSubscription,
+  ProductSubscription$inboundSchema,
+  ProductSubscription$Outbound,
+  ProductSubscription$outboundSchema,
+} from "./productsubscription.js";
+
+export const ProductBundleItemProductType = {
+  Physical: "physical",
+  Digital: "digital",
+  Bundle: "bundle",
+} as const;
+export type ProductBundleItemProductType = ClosedEnum<
+  typeof ProductBundleItemProductType
+>;
+
+export type ProductBundleItemSKU = {
+  quantity: number;
+  productId: string;
+  variantId: string | null;
+  sku: string;
+  slug: string | null;
+  productName: string;
+  variantName: string | null;
+  productType: ProductBundleItemProductType;
+  shortDescription: string | null;
+  active: boolean;
+  stockAvailable: boolean;
+  /**
+   * Indicates whether this item is associated with any active (product-specific) coupons
+   */
+  onOffer: boolean;
+  onSubscription: boolean;
+  onPromotion: boolean;
+  categoryIds: Array<string>;
+  tags: Array<string> | null;
+  reviewsCount: number;
+  reviewsRatingSum: number | null;
+  attributes: Array<ProductAttribute>;
+  images: Array<ProductImage>;
+  pricing: ProductPricing;
+  promotion: ProductPromotion | null;
+  subscription: Array<ProductSubscription>;
+  associatedOptions: { [k: string]: AssociatedOption } | null;
+};
+
+export type ProductBundleItem = {
+  bundleItems: Array<ProductBundleItemSKU>;
+};
+
+/** @internal */
+export const ProductBundleItemProductType$inboundSchema: z.ZodNativeEnum<
+  typeof ProductBundleItemProductType
+> = z.nativeEnum(ProductBundleItemProductType);
+
+/** @internal */
+export const ProductBundleItemProductType$outboundSchema: z.ZodNativeEnum<
+  typeof ProductBundleItemProductType
+> = ProductBundleItemProductType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductBundleItemProductType$ {
+  /** @deprecated use `ProductBundleItemProductType$inboundSchema` instead. */
+  export const inboundSchema = ProductBundleItemProductType$inboundSchema;
+  /** @deprecated use `ProductBundleItemProductType$outboundSchema` instead. */
+  export const outboundSchema = ProductBundleItemProductType$outboundSchema;
+}
+
+/** @internal */
+export const ProductBundleItemSKU$inboundSchema: z.ZodType<
+  ProductBundleItemSKU,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  quantity: z.number().int(),
+  product_id: z.string(),
+  variant_id: z.nullable(z.string()),
+  sku: z.string(),
+  slug: z.nullable(z.string()),
+  product_name: z.string(),
+  variant_name: z.nullable(z.string()),
+  product_type: ProductBundleItemProductType$inboundSchema,
+  short_description: z.nullable(z.string()),
+  active: z.boolean(),
+  stock_available: z.boolean(),
+  on_offer: z.boolean(),
+  on_subscription: z.boolean(),
+  on_promotion: z.boolean(),
+  category_ids: z.array(z.string()),
+  tags: z.nullable(z.array(z.string())),
+  reviews_count: z.number().int(),
+  reviews_rating_sum: z.nullable(z.number()),
+  attributes: z.array(ProductAttribute$inboundSchema),
+  images: z.array(ProductImage$inboundSchema),
+  pricing: ProductPricing$inboundSchema,
+  promotion: z.nullable(ProductPromotion$inboundSchema),
+  subscription: z.array(ProductSubscription$inboundSchema),
+  associated_options: z.nullable(z.record(AssociatedOption$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "product_id": "productId",
+    "variant_id": "variantId",
+    "product_name": "productName",
+    "variant_name": "variantName",
+    "product_type": "productType",
+    "short_description": "shortDescription",
+    "stock_available": "stockAvailable",
+    "on_offer": "onOffer",
+    "on_subscription": "onSubscription",
+    "on_promotion": "onPromotion",
+    "category_ids": "categoryIds",
+    "reviews_count": "reviewsCount",
+    "reviews_rating_sum": "reviewsRatingSum",
+    "associated_options": "associatedOptions",
+  });
+});
+
+/** @internal */
+export type ProductBundleItemSKU$Outbound = {
+  quantity: number;
+  product_id: string;
+  variant_id: string | null;
+  sku: string;
+  slug: string | null;
+  product_name: string;
+  variant_name: string | null;
+  product_type: string;
+  short_description: string | null;
+  active: boolean;
+  stock_available: boolean;
+  on_offer: boolean;
+  on_subscription: boolean;
+  on_promotion: boolean;
+  category_ids: Array<string>;
+  tags: Array<string> | null;
+  reviews_count: number;
+  reviews_rating_sum: number | null;
+  attributes: Array<ProductAttribute$Outbound>;
+  images: Array<ProductImage$Outbound>;
+  pricing: ProductPricing$Outbound;
+  promotion: ProductPromotion$Outbound | null;
+  subscription: Array<ProductSubscription$Outbound>;
+  associated_options: { [k: string]: AssociatedOption$Outbound } | null;
+};
+
+/** @internal */
+export const ProductBundleItemSKU$outboundSchema: z.ZodType<
+  ProductBundleItemSKU$Outbound,
+  z.ZodTypeDef,
+  ProductBundleItemSKU
+> = z.object({
+  quantity: z.number().int(),
+  productId: z.string(),
+  variantId: z.nullable(z.string()),
+  sku: z.string(),
+  slug: z.nullable(z.string()),
+  productName: z.string(),
+  variantName: z.nullable(z.string()),
+  productType: ProductBundleItemProductType$outboundSchema,
+  shortDescription: z.nullable(z.string()),
+  active: z.boolean(),
+  stockAvailable: z.boolean(),
+  onOffer: z.boolean(),
+  onSubscription: z.boolean(),
+  onPromotion: z.boolean(),
+  categoryIds: z.array(z.string()),
+  tags: z.nullable(z.array(z.string())),
+  reviewsCount: z.number().int(),
+  reviewsRatingSum: z.nullable(z.number()),
+  attributes: z.array(ProductAttribute$outboundSchema),
+  images: z.array(ProductImage$outboundSchema),
+  pricing: ProductPricing$outboundSchema,
+  promotion: z.nullable(ProductPromotion$outboundSchema),
+  subscription: z.array(ProductSubscription$outboundSchema),
+  associatedOptions: z.nullable(z.record(AssociatedOption$outboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    productId: "product_id",
+    variantId: "variant_id",
+    productName: "product_name",
+    variantName: "variant_name",
+    productType: "product_type",
+    shortDescription: "short_description",
+    stockAvailable: "stock_available",
+    onOffer: "on_offer",
+    onSubscription: "on_subscription",
+    onPromotion: "on_promotion",
+    categoryIds: "category_ids",
+    reviewsCount: "reviews_count",
+    reviewsRatingSum: "reviews_rating_sum",
+    associatedOptions: "associated_options",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductBundleItemSKU$ {
+  /** @deprecated use `ProductBundleItemSKU$inboundSchema` instead. */
+  export const inboundSchema = ProductBundleItemSKU$inboundSchema;
+  /** @deprecated use `ProductBundleItemSKU$outboundSchema` instead. */
+  export const outboundSchema = ProductBundleItemSKU$outboundSchema;
+  /** @deprecated use `ProductBundleItemSKU$Outbound` instead. */
+  export type Outbound = ProductBundleItemSKU$Outbound;
+}
+
+export function productBundleItemSKUToJSON(
+  productBundleItemSKU: ProductBundleItemSKU,
+): string {
+  return JSON.stringify(
+    ProductBundleItemSKU$outboundSchema.parse(productBundleItemSKU),
+  );
+}
+
+export function productBundleItemSKUFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductBundleItemSKU, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductBundleItemSKU$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductBundleItemSKU' from JSON`,
+  );
+}
+
+/** @internal */
+export const ProductBundleItem$inboundSchema: z.ZodType<
+  ProductBundleItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  bundle_items: z.array(z.lazy(() => ProductBundleItemSKU$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "bundle_items": "bundleItems",
+  });
+});
+
+/** @internal */
+export type ProductBundleItem$Outbound = {
+  bundle_items: Array<ProductBundleItemSKU$Outbound>;
+};
+
+/** @internal */
+export const ProductBundleItem$outboundSchema: z.ZodType<
+  ProductBundleItem$Outbound,
+  z.ZodTypeDef,
+  ProductBundleItem
+> = z.object({
+  bundleItems: z.array(z.lazy(() => ProductBundleItemSKU$outboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    bundleItems: "bundle_items",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductBundleItem$ {
+  /** @deprecated use `ProductBundleItem$inboundSchema` instead. */
+  export const inboundSchema = ProductBundleItem$inboundSchema;
+  /** @deprecated use `ProductBundleItem$outboundSchema` instead. */
+  export const outboundSchema = ProductBundleItem$outboundSchema;
+  /** @deprecated use `ProductBundleItem$Outbound` instead. */
+  export type Outbound = ProductBundleItem$Outbound;
+}
+
+export function productBundleItemToJSON(
+  productBundleItem: ProductBundleItem,
+): string {
+  return JSON.stringify(
+    ProductBundleItem$outboundSchema.parse(productBundleItem),
+  );
+}
+
+export function productBundleItemFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductBundleItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductBundleItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductBundleItem' from JSON`,
+  );
+}

package/src/models/components/productdetail.ts

@@ -3,48 +3,321 @@
  */
 
 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 {
-  BundleProductDetail,
-  BundleProductDetail$inboundSchema,
-  BundleProductDetail$Outbound,
-  BundleProductDetail$outboundSchema,
-} from "./bundleproductdetail.js";
+  ProductAttribute,
+  ProductAttribute$inboundSchema,
+  ProductAttribute$Outbound,
+  ProductAttribute$outboundSchema,
+} from "./productattribute.js";
 import {
-  SingleProductDetail,
-  SingleProductDetail$inboundSchema,
-  SingleProductDetail$Outbound,
-  SingleProductDetail$outboundSchema,
-} from "./singleproductdetail.js";
+  ProductBundleItem,
+  ProductBundleItem$inboundSchema,
+  ProductBundleItem$Outbound,
+  ProductBundleItem$outboundSchema,
+} from "./productbundleitem.js";
+import {
+  ProductImage,
+  ProductImage$inboundSchema,
+  ProductImage$Outbound,
+  ProductImage$outboundSchema,
+} from "./productimage.js";
+import {
+  ProductPricing,
+  ProductPricing$inboundSchema,
+  ProductPricing$Outbound,
+  ProductPricing$outboundSchema,
+} from "./productpricing.js";
+import {
+  ProductPromotion,
+  ProductPromotion$inboundSchema,
+  ProductPromotion$Outbound,
+  ProductPromotion$outboundSchema,
+} from "./productpromotion.js";
+import {
+  ProductShipping,
+  ProductShipping$inboundSchema,
+  ProductShipping$Outbound,
+  ProductShipping$outboundSchema,
+} from "./productshipping.js";
+import {
+  ProductSubscription,
+  ProductSubscription$inboundSchema,
+  ProductSubscription$Outbound,
+  ProductSubscription$outboundSchema,
+} from "./productsubscription.js";
+import {
+  ProductVideo,
+  ProductVideo$inboundSchema,
+  ProductVideo$Outbound,
+  ProductVideo$outboundSchema,
+} from "./productvideo.js";
+import {
+  Seo,
+  Seo$inboundSchema,
+  Seo$Outbound,
+  Seo$outboundSchema,
+} from "./seo.js";
+import {
+  Variant,
+  Variant$inboundSchema,
+  Variant$Outbound,
+  Variant$outboundSchema,
+} from "./variant.js";
+import {
+  VariantOption,
+  VariantOption$inboundSchema,
+  VariantOption$Outbound,
+  VariantOption$outboundSchema,
+} from "./variantoption.js";
+
+export const ProductDetailProductType = {
+  Physical: "physical",
+  Digital: "digital",
+  Bundle: "bundle",
+} as const;
+export type ProductDetailProductType = ClosedEnum<
+  typeof ProductDetailProductType
+>;
 
-export type ProductDetail = SingleProductDetail | BundleProductDetail;
+export type ProductDetail = {
+  /**
+   * The ULID of the product
+   */
+  id: string;
+  sku: string | null;
+  name: string;
+  slug: string | null;
+  shortDescription: string | null;
+  productType: ProductDetailProductType;
+  active: boolean;
+  /**
+   * Indicates whether the product has stock available
+   */
+  stockAvailable: boolean;
+  /**
+   * Indicates whether this item is associated with any active (product-specific) coupons
+   */
+  onOffer: boolean;
+  /**
+   * Indicates whether the product has any subscription plans avaialble
+   */
+  onSubscription: boolean;
+  /**
+   * Indicates whether the product is currently on promotion. When true, the `ProductPromotion` object will contain details of the promotion
+   */
+  onPromotion: boolean;
+  /**
+   * Indicates whether the product has variants
+   */
+  hasVariant: boolean;
+  tags: Array<string> | null;
+  categoryIds: Array<string>;
+  reviewsRatingSum: number;
+  reviewsCount: number;
+  attributes: Array<ProductAttribute>;
+  pricing: ProductPricing;
+  /**
+   * this will be used if has_variant is true, to auto set default values.
+   */
+  variantOptions: Array<VariantOption> | null;
+  promotion: ProductPromotion | null;
+  images: Array<ProductImage>;
+  subscription: Array<ProductSubscription>;
+  variants: Array<Variant>;
+  bundleItems: ProductBundleItem;
+  description: string | null;
+  hsnCode: string | null;
+  videos: Array<ProductVideo>;
+  shipping: ProductShipping | null;
+  /**
+   * An array of product ULIDs
+   */
+  upsellingProductIds: Array<string>;
+  /**
+   * An array of product ULIDs
+   */
+  crosssellingProductIds: Array<string>;
+  seo: Seo;
+  metadata: { [k: string]: string };
+};
+
+/** @internal */
+export const ProductDetailProductType$inboundSchema: z.ZodNativeEnum<
+  typeof ProductDetailProductType
+> = z.nativeEnum(ProductDetailProductType);
+
+/** @internal */
+export const ProductDetailProductType$outboundSchema: z.ZodNativeEnum<
+  typeof ProductDetailProductType
+> = ProductDetailProductType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductDetailProductType$ {
+  /** @deprecated use `ProductDetailProductType$inboundSchema` instead. */
+  export const inboundSchema = ProductDetailProductType$inboundSchema;
+  /** @deprecated use `ProductDetailProductType$outboundSchema` instead. */
+  export const outboundSchema = ProductDetailProductType$outboundSchema;
+}
 
 /** @internal */
 export const ProductDetail$inboundSchema: z.ZodType<
   ProductDetail,
   z.ZodTypeDef,
   unknown
-> = z.union([
-  SingleProductDetail$inboundSchema,
-  BundleProductDetail$inboundSchema,
-]);
+> = z.object({
+  id: z.string(),
+  sku: z.nullable(z.string()),
+  name: z.string(),
+  slug: z.nullable(z.string()),
+  short_description: z.nullable(z.string()),
+  product_type: ProductDetailProductType$inboundSchema,
+  active: z.boolean(),
+  stock_available: z.boolean(),
+  on_offer: z.boolean(),
+  on_subscription: z.boolean(),
+  on_promotion: z.boolean(),
+  has_variant: z.boolean(),
+  tags: z.nullable(z.array(z.string())),
+  category_ids: z.array(z.string()),
+  reviews_rating_sum: z.number(),
+  reviews_count: z.number().int(),
+  attributes: z.array(ProductAttribute$inboundSchema),
+  pricing: ProductPricing$inboundSchema,
+  variant_options: z.nullable(z.array(VariantOption$inboundSchema)),
+  promotion: z.nullable(ProductPromotion$inboundSchema),
+  images: z.array(ProductImage$inboundSchema),
+  subscription: z.array(ProductSubscription$inboundSchema),
+  variants: z.array(Variant$inboundSchema),
+  bundle_items: ProductBundleItem$inboundSchema,
+  description: z.nullable(z.string()),
+  hsn_code: z.nullable(z.string()),
+  videos: z.array(ProductVideo$inboundSchema),
+  shipping: z.nullable(ProductShipping$inboundSchema),
+  upselling_product_ids: z.array(z.string()),
+  crossselling_product_ids: z.array(z.string()),
+  seo: Seo$inboundSchema,
+  metadata: z.record(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "short_description": "shortDescription",
+    "product_type": "productType",
+    "stock_available": "stockAvailable",
+    "on_offer": "onOffer",
+    "on_subscription": "onSubscription",
+    "on_promotion": "onPromotion",
+    "has_variant": "hasVariant",
+    "category_ids": "categoryIds",
+    "reviews_rating_sum": "reviewsRatingSum",
+    "reviews_count": "reviewsCount",
+    "variant_options": "variantOptions",
+    "bundle_items": "bundleItems",
+    "hsn_code": "hsnCode",
+    "upselling_product_ids": "upsellingProductIds",
+    "crossselling_product_ids": "crosssellingProductIds",
+  });
+});
 
 /** @internal */
-export type ProductDetail$Outbound =
-  | SingleProductDetail$Outbound
-  | BundleProductDetail$Outbound;
+export type ProductDetail$Outbound = {
+  id: string;
+  sku: string | null;
+  name: string;
+  slug: string | null;
+  short_description: string | null;
+  product_type: string;
+  active: boolean;
+  stock_available: boolean;
+  on_offer: boolean;
+  on_subscription: boolean;
+  on_promotion: boolean;
+  has_variant: boolean;
+  tags: Array<string> | null;
+  category_ids: Array<string>;
+  reviews_rating_sum: number;
+  reviews_count: number;
+  attributes: Array<ProductAttribute$Outbound>;
+  pricing: ProductPricing$Outbound;
+  variant_options: Array<VariantOption$Outbound> | null;
+  promotion: ProductPromotion$Outbound | null;
+  images: Array<ProductImage$Outbound>;
+  subscription: Array<ProductSubscription$Outbound>;
+  variants: Array<Variant$Outbound>;
+  bundle_items: ProductBundleItem$Outbound;
+  description: string | null;
+  hsn_code: string | null;
+  videos: Array<ProductVideo$Outbound>;
+  shipping: ProductShipping$Outbound | null;
+  upselling_product_ids: Array<string>;
+  crossselling_product_ids: Array<string>;
+  seo: Seo$Outbound;
+  metadata: { [k: string]: string };
+};
 
 /** @internal */
 export const ProductDetail$outboundSchema: z.ZodType<
   ProductDetail$Outbound,
   z.ZodTypeDef,
   ProductDetail
-> = z.union([
-  SingleProductDetail$outboundSchema,
-  BundleProductDetail$outboundSchema,
-]);
+> = z.object({
+  id: z.string(),
+  sku: z.nullable(z.string()),
+  name: z.string(),
+  slug: z.nullable(z.string()),
+  shortDescription: z.nullable(z.string()),
+  productType: ProductDetailProductType$outboundSchema,
+  active: z.boolean(),
+  stockAvailable: z.boolean(),
+  onOffer: z.boolean(),
+  onSubscription: z.boolean(),
+  onPromotion: z.boolean(),
+  hasVariant: z.boolean(),
+  tags: z.nullable(z.array(z.string())),
+  categoryIds: z.array(z.string()),
+  reviewsRatingSum: z.number(),
+  reviewsCount: z.number().int(),
+  attributes: z.array(ProductAttribute$outboundSchema),
+  pricing: ProductPricing$outboundSchema,
+  variantOptions: z.nullable(z.array(VariantOption$outboundSchema)),
+  promotion: z.nullable(ProductPromotion$outboundSchema),
+  images: z.array(ProductImage$outboundSchema),
+  subscription: z.array(ProductSubscription$outboundSchema),
+  variants: z.array(Variant$outboundSchema),
+  bundleItems: ProductBundleItem$outboundSchema,
+  description: z.nullable(z.string()),
+  hsnCode: z.nullable(z.string()),
+  videos: z.array(ProductVideo$outboundSchema),
+  shipping: z.nullable(ProductShipping$outboundSchema),
+  upsellingProductIds: z.array(z.string()),
+  crosssellingProductIds: z.array(z.string()),
+  seo: Seo$outboundSchema,
+  metadata: z.record(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    shortDescription: "short_description",
+    productType: "product_type",
+    stockAvailable: "stock_available",
+    onOffer: "on_offer",
+    onSubscription: "on_subscription",
+    onPromotion: "on_promotion",
+    hasVariant: "has_variant",
+    categoryIds: "category_ids",
+    reviewsRatingSum: "reviews_rating_sum",
+    reviewsCount: "reviews_count",
+    variantOptions: "variant_options",
+    bundleItems: "bundle_items",
+    hsnCode: "hsn_code",
+    upsellingProductIds: "upselling_product_ids",
+    crosssellingProductIds: "crossselling_product_ids",
+  });
+});
 
 /**
  * @internal