ce-storefront 0.3.6 → 0.3.8

package/src/models/components/bundleproduct.ts

@@ -0,0 +1,501 @@
+/*
+ * 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";
+import {
+  VariantOption,
+  VariantOption$inboundSchema,
+  VariantOption$Outbound,
+  VariantOption$outboundSchema,
+} from "./variantoption.js";
+
+export const BundleProductProductType = {
+  Physical: "physical",
+  Digital: "digital",
+  Bundle: "bundle",
+} as const;
+export type BundleProductProductType = ClosedEnum<
+  typeof BundleProductProductType
+>;
+
+export const BundleProductBundleItemsProductType = {
+  Physical: "physical",
+  Digital: "digital",
+  Bundle: "bundle",
+} as const;
+export type BundleProductBundleItemsProductType = ClosedEnum<
+  typeof BundleProductBundleItemsProductType
+>;
+
+export type BundleProductSKU = {
+  quantity: number;
+  productId: string;
+  variantId?: string | null | undefined;
+  sku: string;
+  slug?: string | undefined;
+  productName: string;
+  variantName?: string | null | undefined;
+  productType: BundleProductBundleItemsProductType;
+  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 BundleProduct = {
+  /**
+   * The ULID of the product
+   */
+  id: string;
+  sku?: string | undefined;
+  name: string;
+  slug: string;
+  shortDescription?: string | undefined;
+  productType: BundleProductProductType;
+  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<BundleProductSKU> | undefined;
+};
+
+/** @internal */
+export const BundleProductProductType$inboundSchema: z.ZodNativeEnum<
+  typeof BundleProductProductType
+> = z.nativeEnum(BundleProductProductType);
+
+/** @internal */
+export const BundleProductProductType$outboundSchema: z.ZodNativeEnum<
+  typeof BundleProductProductType
+> = BundleProductProductType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BundleProductProductType$ {
+  /** @deprecated use `BundleProductProductType$inboundSchema` instead. */
+  export const inboundSchema = BundleProductProductType$inboundSchema;
+  /** @deprecated use `BundleProductProductType$outboundSchema` instead. */
+  export const outboundSchema = BundleProductProductType$outboundSchema;
+}
+
+/** @internal */
+export const BundleProductBundleItemsProductType$inboundSchema: z.ZodNativeEnum<
+  typeof BundleProductBundleItemsProductType
+> = z.nativeEnum(BundleProductBundleItemsProductType);
+
+/** @internal */
+export const BundleProductBundleItemsProductType$outboundSchema:
+  z.ZodNativeEnum<typeof BundleProductBundleItemsProductType> =
+    BundleProductBundleItemsProductType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BundleProductBundleItemsProductType$ {
+  /** @deprecated use `BundleProductBundleItemsProductType$inboundSchema` instead. */
+  export const inboundSchema =
+    BundleProductBundleItemsProductType$inboundSchema;
+  /** @deprecated use `BundleProductBundleItemsProductType$outboundSchema` instead. */
+  export const outboundSchema =
+    BundleProductBundleItemsProductType$outboundSchema;
+}
+
+/** @internal */
+export const BundleProductSKU$inboundSchema: z.ZodType<
+  BundleProductSKU,
+  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: BundleProductBundleItemsProductType$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 BundleProductSKU$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 BundleProductSKU$outboundSchema: z.ZodType<
+  BundleProductSKU$Outbound,
+  z.ZodTypeDef,
+  BundleProductSKU
+> = 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: BundleProductBundleItemsProductType$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 BundleProductSKU$ {
+  /** @deprecated use `BundleProductSKU$inboundSchema` instead. */
+  export const inboundSchema = BundleProductSKU$inboundSchema;
+  /** @deprecated use `BundleProductSKU$outboundSchema` instead. */
+  export const outboundSchema = BundleProductSKU$outboundSchema;
+  /** @deprecated use `BundleProductSKU$Outbound` instead. */
+  export type Outbound = BundleProductSKU$Outbound;
+}
+
+export function bundleProductSKUToJSON(
+  bundleProductSKU: BundleProductSKU,
+): string {
+  return JSON.stringify(
+    BundleProductSKU$outboundSchema.parse(bundleProductSKU),
+  );
+}
+
+export function bundleProductSKUFromJSON(
+  jsonString: string,
+): SafeParseResult<BundleProductSKU, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BundleProductSKU$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BundleProductSKU' from JSON`,
+  );
+}
+
+/** @internal */
+export const BundleProduct$inboundSchema: z.ZodType<
+  BundleProduct,
+  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: BundleProductProductType$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(() => BundleProductSKU$inboundSchema))
+    .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",
+  });
+});
+
+/** @internal */
+export type BundleProduct$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<BundleProductSKU$Outbound> | undefined;
+};
+
+/** @internal */
+export const BundleProduct$outboundSchema: z.ZodType<
+  BundleProduct$Outbound,
+  z.ZodTypeDef,
+  BundleProduct
+> = z.object({
+  id: z.string(),
+  sku: z.string().optional(),
+  name: z.string(),
+  slug: z.string(),
+  shortDescription: z.string().optional(),
+  productType: BundleProductProductType$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(() => BundleProductSKU$outboundSchema))
+    .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",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BundleProduct$ {
+  /** @deprecated use `BundleProduct$inboundSchema` instead. */
+  export const inboundSchema = BundleProduct$inboundSchema;
+  /** @deprecated use `BundleProduct$outboundSchema` instead. */
+  export const outboundSchema = BundleProduct$outboundSchema;
+  /** @deprecated use `BundleProduct$Outbound` instead. */
+  export type Outbound = BundleProduct$Outbound;
+}
+
+export function bundleProductToJSON(bundleProduct: BundleProduct): string {
+  return JSON.stringify(BundleProduct$outboundSchema.parse(bundleProduct));
+}
+
+export function bundleProductFromJSON(
+  jsonString: string,
+): SafeParseResult<BundleProduct, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BundleProduct$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BundleProduct' from JSON`,
+  );
+}