ce-storefront 0.3.6 → 0.3.8

package/src/models/components/bundleproductdetail.ts

@@ -0,0 +1,567 @@
+/*
+ * 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 {
+  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 {
+  VariantOption,
+  VariantOption$inboundSchema,
+  VariantOption$Outbound,
+  VariantOption$outboundSchema,
+} from "./variantoption.js";
+
+export const BundleProductDetailProductType = {
+  Physical: "physical",
+  Digital: "digital",
+  Bundle: "bundle",
+} as const;
+export type BundleProductDetailProductType = ClosedEnum<
+  typeof BundleProductDetailProductType
+>;
+
+export const BundleProductDetailBundleItemsProductType = {
+  Physical: "physical",
+  Digital: "digital",
+  Bundle: "bundle",
+} as const;
+export type BundleProductDetailBundleItemsProductType = ClosedEnum<
+  typeof BundleProductDetailBundleItemsProductType
+>;
+
+export type BundleProductDetailSKU = {
+  quantity: number;
+  productId: string;
+  variantId?: string | null | undefined;
+  sku: string;
+  slug?: string | undefined;
+  productName: string;
+  variantName?: string | null | undefined;
+  productType: BundleProductDetailBundleItemsProductType;
+  shortDescription?: string | undefined;
+  active?: boolean | undefined;
+  stockAvailable?: boolean | undefined;
+  /**
+   * Indicates whether this item is associated with any active (product-specific) coupons
+   */
+  onOffer?: boolean | undefined;
+  onSubscription?: boolean | undefined;
+  onPromotion?: boolean | undefined;
+  categoryIds?: Array<string> | undefined;
+  tags?: Array<string> | undefined;
+  reviewsCount?: number | undefined;
+  reviewsRatingSum?: number | undefined;
+  attributes?: Array<ProductAttribute> | undefined;
+  images?: Array<ProductImage> | undefined;
+  pricing?: ProductPricing | undefined;
+  promotion?: ProductPromotion | null | undefined;
+  subscription?: Array<ProductSubscription> | undefined;
+  associatedOptions?: { [k: string]: AssociatedOption } | null | undefined;
+};
+
+export type BundleProductDetail = {
+  /**
+   * The ULID of the product
+   */
+  id: string;
+  sku?: string | undefined;
+  name: string;
+  slug: string;
+  shortDescription?: string | undefined;
+  productType: BundleProductDetailProductType;
+  active?: boolean | undefined;
+  /**
+   * Indicates whether the product has stock available
+   */
+  stockAvailable?: boolean | undefined;
+  /**
+   * Indicates whether this item is associated with any active (product-specific) coupons
+   */
+  onOffer?: boolean | undefined;
+  /**
+   * Indicates whether the product has any subscription plans avaialble
+   */
+  onSubscription?: boolean | undefined;
+  /**
+   * Indicates whether the product is currently on promotion. When true, the `ProductPromotion` object will contain details of the promotion
+   */
+  onPromotion?: boolean | undefined;
+  /**
+   * Indicates whether the product has variants
+   */
+  hasVariant?: boolean | undefined;
+  tags?: Array<string> | null | undefined;
+  categoryIds?: Array<string> | undefined;
+  reviewsRatingSum?: number | undefined;
+  reviewsCount?: number | undefined;
+  attributes?: Array<ProductAttribute> | undefined;
+  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>;
+  bundleItems?: Array<BundleProductDetailSKU> | undefined;
+  description?: string | undefined;
+  hsnCode?: string | undefined;
+  videos?: Array<ProductVideo> | undefined;
+  shipping?: ProductShipping | null | undefined;
+  /**
+   * An array of product ULIDs
+   */
+  upsellingProductIds?: Array<string> | undefined;
+  /**
+   * An array of product ULIDs
+   */
+  crosssellingProductIds?: Array<string> | undefined;
+  seo?: Seo | undefined;
+  metadata?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const BundleProductDetailProductType$inboundSchema: z.ZodNativeEnum<
+  typeof BundleProductDetailProductType
+> = z.nativeEnum(BundleProductDetailProductType);
+
+/** @internal */
+export const BundleProductDetailProductType$outboundSchema: z.ZodNativeEnum<
+  typeof BundleProductDetailProductType
+> = BundleProductDetailProductType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BundleProductDetailProductType$ {
+  /** @deprecated use `BundleProductDetailProductType$inboundSchema` instead. */
+  export const inboundSchema = BundleProductDetailProductType$inboundSchema;
+  /** @deprecated use `BundleProductDetailProductType$outboundSchema` instead. */
+  export const outboundSchema = BundleProductDetailProductType$outboundSchema;
+}
+
+/** @internal */
+export const BundleProductDetailBundleItemsProductType$inboundSchema:
+  z.ZodNativeEnum<typeof BundleProductDetailBundleItemsProductType> = z
+    .nativeEnum(BundleProductDetailBundleItemsProductType);
+
+/** @internal */
+export const BundleProductDetailBundleItemsProductType$outboundSchema:
+  z.ZodNativeEnum<typeof BundleProductDetailBundleItemsProductType> =
+    BundleProductDetailBundleItemsProductType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BundleProductDetailBundleItemsProductType$ {
+  /** @deprecated use `BundleProductDetailBundleItemsProductType$inboundSchema` instead. */
+  export const inboundSchema =
+    BundleProductDetailBundleItemsProductType$inboundSchema;
+  /** @deprecated use `BundleProductDetailBundleItemsProductType$outboundSchema` instead. */
+  export const outboundSchema =
+    BundleProductDetailBundleItemsProductType$outboundSchema;
+}
+
+/** @internal */
+export const BundleProductDetailSKU$inboundSchema: z.ZodType<
+  BundleProductDetailSKU,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  quantity: z.number().int(),
+  product_id: z.string(),
+  variant_id: z.nullable(z.string()).optional(),
+  sku: z.string(),
+  slug: z.string().optional(),
+  product_name: z.string(),
+  variant_name: z.nullable(z.string()).optional(),
+  product_type: BundleProductDetailBundleItemsProductType$inboundSchema,
+  short_description: z.string().optional(),
+  active: z.boolean().default(true),
+  stock_available: z.boolean().default(true),
+  on_offer: z.boolean().default(false),
+  on_subscription: z.boolean().default(false),
+  on_promotion: z.boolean().default(false),
+  category_ids: z.array(z.string()).optional(),
+  tags: z.array(z.string()).optional(),
+  reviews_count: z.number().int().optional(),
+  reviews_rating_sum: z.number().optional(),
+  attributes: z.array(ProductAttribute$inboundSchema).optional(),
+  images: z.array(ProductImage$inboundSchema).optional(),
+  pricing: ProductPricing$inboundSchema.optional(),
+  promotion: z.nullable(ProductPromotion$inboundSchema).optional(),
+  subscription: z.array(ProductSubscription$inboundSchema).optional(),
+  associated_options: z.nullable(z.record(AssociatedOption$inboundSchema))
+    .optional(),
+}).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 BundleProductDetailSKU$Outbound = {
+  quantity: number;
+  product_id: string;
+  variant_id?: string | null | undefined;
+  sku: string;
+  slug?: string | undefined;
+  product_name: string;
+  variant_name?: string | null | undefined;
+  product_type: string;
+  short_description?: string | undefined;
+  active: boolean;
+  stock_available: boolean;
+  on_offer: boolean;
+  on_subscription: boolean;
+  on_promotion: boolean;
+  category_ids?: Array<string> | undefined;
+  tags?: Array<string> | undefined;
+  reviews_count?: number | undefined;
+  reviews_rating_sum?: number | undefined;
+  attributes?: Array<ProductAttribute$Outbound> | undefined;
+  images?: Array<ProductImage$Outbound> | undefined;
+  pricing?: ProductPricing$Outbound | undefined;
+  promotion?: ProductPromotion$Outbound | null | undefined;
+  subscription?: Array<ProductSubscription$Outbound> | undefined;
+  associated_options?:
+    | { [k: string]: AssociatedOption$Outbound }
+    | null
+    | undefined;
+};
+
+/** @internal */
+export const BundleProductDetailSKU$outboundSchema: z.ZodType<
+  BundleProductDetailSKU$Outbound,
+  z.ZodTypeDef,
+  BundleProductDetailSKU
+> = z.object({
+  quantity: z.number().int(),
+  productId: z.string(),
+  variantId: z.nullable(z.string()).optional(),
+  sku: z.string(),
+  slug: z.string().optional(),
+  productName: z.string(),
+  variantName: z.nullable(z.string()).optional(),
+  productType: BundleProductDetailBundleItemsProductType$outboundSchema,
+  shortDescription: z.string().optional(),
+  active: z.boolean().default(true),
+  stockAvailable: z.boolean().default(true),
+  onOffer: z.boolean().default(false),
+  onSubscription: z.boolean().default(false),
+  onPromotion: z.boolean().default(false),
+  categoryIds: z.array(z.string()).optional(),
+  tags: z.array(z.string()).optional(),
+  reviewsCount: z.number().int().optional(),
+  reviewsRatingSum: z.number().optional(),
+  attributes: z.array(ProductAttribute$outboundSchema).optional(),
+  images: z.array(ProductImage$outboundSchema).optional(),
+  pricing: ProductPricing$outboundSchema.optional(),
+  promotion: z.nullable(ProductPromotion$outboundSchema).optional(),
+  subscription: z.array(ProductSubscription$outboundSchema).optional(),
+  associatedOptions: z.nullable(z.record(AssociatedOption$outboundSchema))
+    .optional(),
+}).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 BundleProductDetailSKU$ {
+  /** @deprecated use `BundleProductDetailSKU$inboundSchema` instead. */
+  export const inboundSchema = BundleProductDetailSKU$inboundSchema;
+  /** @deprecated use `BundleProductDetailSKU$outboundSchema` instead. */
+  export const outboundSchema = BundleProductDetailSKU$outboundSchema;
+  /** @deprecated use `BundleProductDetailSKU$Outbound` instead. */
+  export type Outbound = BundleProductDetailSKU$Outbound;
+}
+
+export function bundleProductDetailSKUToJSON(
+  bundleProductDetailSKU: BundleProductDetailSKU,
+): string {
+  return JSON.stringify(
+    BundleProductDetailSKU$outboundSchema.parse(bundleProductDetailSKU),
+  );
+}
+
+export function bundleProductDetailSKUFromJSON(
+  jsonString: string,
+): SafeParseResult<BundleProductDetailSKU, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BundleProductDetailSKU$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BundleProductDetailSKU' from JSON`,
+  );
+}
+
+/** @internal */
+export const BundleProductDetail$inboundSchema: z.ZodType<
+  BundleProductDetail,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  sku: z.string().optional(),
+  name: z.string(),
+  slug: z.string(),
+  short_description: z.string().optional(),
+  product_type: BundleProductDetailProductType$inboundSchema,
+  active: z.boolean().default(true),
+  stock_available: z.boolean().default(true),
+  on_offer: z.boolean().default(false),
+  on_subscription: z.boolean().default(false),
+  on_promotion: z.boolean().default(false),
+  has_variant: z.boolean().default(false),
+  tags: z.nullable(z.array(z.string())).optional(),
+  category_ids: z.array(z.string()).optional(),
+  reviews_rating_sum: z.number().optional(),
+  reviews_count: z.number().int().optional(),
+  attributes: z.array(ProductAttribute$inboundSchema).optional(),
+  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),
+  bundle_items: z.array(z.lazy(() => BundleProductDetailSKU$inboundSchema))
+    .optional(),
+  description: z.string().optional(),
+  hsn_code: z.string().optional(),
+  videos: z.array(ProductVideo$inboundSchema).optional(),
+  shipping: z.nullable(ProductShipping$inboundSchema).optional(),
+  upselling_product_ids: z.array(z.string()).optional(),
+  crossselling_product_ids: z.array(z.string()).optional(),
+  seo: Seo$inboundSchema.optional(),
+  metadata: z.record(z.string()).optional(),
+}).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 BundleProductDetail$Outbound = {
+  id: string;
+  sku?: string | undefined;
+  name: string;
+  slug: string;
+  short_description?: string | undefined;
+  product_type: string;
+  active: boolean;
+  stock_available: boolean;
+  on_offer: boolean;
+  on_subscription: boolean;
+  on_promotion: boolean;
+  has_variant: boolean;
+  tags?: Array<string> | null | undefined;
+  category_ids?: Array<string> | undefined;
+  reviews_rating_sum?: number | undefined;
+  reviews_count?: number | undefined;
+  attributes?: Array<ProductAttribute$Outbound> | undefined;
+  pricing: ProductPricing$Outbound;
+  variant_options: Array<VariantOption$Outbound> | null;
+  promotion: ProductPromotion$Outbound | null;
+  images: Array<ProductImage$Outbound>;
+  subscription: Array<ProductSubscription$Outbound>;
+  bundle_items?: Array<BundleProductDetailSKU$Outbound> | undefined;
+  description?: string | undefined;
+  hsn_code?: string | undefined;
+  videos?: Array<ProductVideo$Outbound> | undefined;
+  shipping?: ProductShipping$Outbound | null | undefined;
+  upselling_product_ids?: Array<string> | undefined;
+  crossselling_product_ids?: Array<string> | undefined;
+  seo?: Seo$Outbound | undefined;
+  metadata?: { [k: string]: string } | undefined;
+};
+
+/** @internal */
+export const BundleProductDetail$outboundSchema: z.ZodType<
+  BundleProductDetail$Outbound,
+  z.ZodTypeDef,
+  BundleProductDetail
+> = z.object({
+  id: z.string(),
+  sku: z.string().optional(),
+  name: z.string(),
+  slug: z.string(),
+  shortDescription: z.string().optional(),
+  productType: BundleProductDetailProductType$outboundSchema,
+  active: z.boolean().default(true),
+  stockAvailable: z.boolean().default(true),
+  onOffer: z.boolean().default(false),
+  onSubscription: z.boolean().default(false),
+  onPromotion: z.boolean().default(false),
+  hasVariant: z.boolean().default(false),
+  tags: z.nullable(z.array(z.string())).optional(),
+  categoryIds: z.array(z.string()).optional(),
+  reviewsRatingSum: z.number().optional(),
+  reviewsCount: z.number().int().optional(),
+  attributes: z.array(ProductAttribute$outboundSchema).optional(),
+  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),
+  bundleItems: z.array(z.lazy(() => BundleProductDetailSKU$outboundSchema))
+    .optional(),
+  description: z.string().optional(),
+  hsnCode: z.string().optional(),
+  videos: z.array(ProductVideo$outboundSchema).optional(),
+  shipping: z.nullable(ProductShipping$outboundSchema).optional(),
+  upsellingProductIds: z.array(z.string()).optional(),
+  crosssellingProductIds: z.array(z.string()).optional(),
+  seo: Seo$outboundSchema.optional(),
+  metadata: z.record(z.string()).optional(),
+}).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
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BundleProductDetail$ {
+  /** @deprecated use `BundleProductDetail$inboundSchema` instead. */
+  export const inboundSchema = BundleProductDetail$inboundSchema;
+  /** @deprecated use `BundleProductDetail$outboundSchema` instead. */
+  export const outboundSchema = BundleProductDetail$outboundSchema;
+  /** @deprecated use `BundleProductDetail$Outbound` instead. */
+  export type Outbound = BundleProductDetail$Outbound;
+}
+
+export function bundleProductDetailToJSON(
+  bundleProductDetail: BundleProductDetail,
+): string {
+  return JSON.stringify(
+    BundleProductDetail$outboundSchema.parse(bundleProductDetail),
+  );
+}
+
+export function bundleProductDetailFromJSON(
+  jsonString: string,
+): SafeParseResult<BundleProductDetail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BundleProductDetail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BundleProductDetail' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -6,6 +6,8 @@ export * from "./analyticsevent.js";
 export * from "./anonymoususer.js";
 export * from "./associatedoption.js";
 export * from "./banktransfer.js";
+export * from "./bundleproduct.js";
+export * from "./bundleproductdetail.js";
 export * from "./business.js";
 export * from "./cardpayment.js";
 export * from "./cart.js";
@@ -52,7 +54,6 @@ export * from "./payupaymentinfo.js";
 export * from "./payupaymentmethod.js";
 export * from "./payusavedcard.js";
 export * from "./pincode.js";
-export * from "./product.js";
 export * from "./productattribute.js";
 export * from "./productcategory.js";
 export * from "./productdetail.js";
@@ -68,6 +69,8 @@ export * from "./promotiondetail.js";
 export * from "./security.js";
 export * from "./seo.js";
 export * from "./shipmentitem.js";
+export * from "./singleproduct.js";
+export * from "./singleproductdetail.js";
 export * from "./sku.js";
 export * from "./updatecustomer.js";
 export * from "./upipayment.js";