ce-storefront 0.3.5 → 0.3.7

package/src/models/components/singleproduct.ts

@@ -0,0 +1,269 @@
+/*
+ * 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 {
+  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 {
+  Variant,
+  Variant$inboundSchema,
+  Variant$Outbound,
+  Variant$outboundSchema,
+} from "./variant.js";
+import {
+  VariantOption,
+  VariantOption$inboundSchema,
+  VariantOption$Outbound,
+  VariantOption$outboundSchema,
+} from "./variantoption.js";
+
+export const ProductType = {
+  Physical: "physical",
+  Digital: "digital",
+  Bundle: "bundle",
+} as const;
+export type ProductType = ClosedEnum<typeof ProductType>;
+
+export type SingleProduct = {
+  /**
+   * The ULID of the product
+   */
+  id: string;
+  sku?: string | undefined;
+  name: string;
+  slug: string;
+  shortDescription?: string | undefined;
+  productType: ProductType;
+  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 | undefined;
+  /**
+   * this will be used if has_variant is true, to auto set default values.
+   */
+  variantOptions?: Array<VariantOption> | null | undefined;
+  promotion?: ProductPromotion | null | undefined;
+  images?: Array<ProductImage> | undefined;
+  subscription?: Array<ProductSubscription> | undefined;
+  variants?: Array<Variant> | undefined;
+};
+
+/** @internal */
+export const ProductType$inboundSchema: z.ZodNativeEnum<typeof ProductType> = z
+  .nativeEnum(ProductType);
+
+/** @internal */
+export const ProductType$outboundSchema: z.ZodNativeEnum<typeof ProductType> =
+  ProductType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductType$ {
+  /** @deprecated use `ProductType$inboundSchema` instead. */
+  export const inboundSchema = ProductType$inboundSchema;
+  /** @deprecated use `ProductType$outboundSchema` instead. */
+  export const outboundSchema = ProductType$outboundSchema;
+}
+
+/** @internal */
+export const SingleProduct$inboundSchema: z.ZodType<
+  SingleProduct,
+  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: ProductType$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.optional(),
+  variant_options: z.nullable(z.array(VariantOption$inboundSchema)).optional(),
+  promotion: z.nullable(ProductPromotion$inboundSchema).optional(),
+  images: z.array(ProductImage$inboundSchema).optional(),
+  subscription: z.array(ProductSubscription$inboundSchema).optional(),
+  variants: z.array(Variant$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",
+  });
+});
+
+/** @internal */
+export type SingleProduct$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 | undefined;
+  variant_options?: Array<VariantOption$Outbound> | null | undefined;
+  promotion?: ProductPromotion$Outbound | null | undefined;
+  images?: Array<ProductImage$Outbound> | undefined;
+  subscription?: Array<ProductSubscription$Outbound> | undefined;
+  variants?: Array<Variant$Outbound> | undefined;
+};
+
+/** @internal */
+export const SingleProduct$outboundSchema: z.ZodType<
+  SingleProduct$Outbound,
+  z.ZodTypeDef,
+  SingleProduct
+> = z.object({
+  id: z.string(),
+  sku: z.string().optional(),
+  name: z.string(),
+  slug: z.string(),
+  shortDescription: z.string().optional(),
+  productType: ProductType$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.optional(),
+  variantOptions: z.nullable(z.array(VariantOption$outboundSchema)).optional(),
+  promotion: z.nullable(ProductPromotion$outboundSchema).optional(),
+  images: z.array(ProductImage$outboundSchema).optional(),
+  subscription: z.array(ProductSubscription$outboundSchema).optional(),
+  variants: z.array(Variant$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",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SingleProduct$ {
+  /** @deprecated use `SingleProduct$inboundSchema` instead. */
+  export const inboundSchema = SingleProduct$inboundSchema;
+  /** @deprecated use `SingleProduct$outboundSchema` instead. */
+  export const outboundSchema = SingleProduct$outboundSchema;
+  /** @deprecated use `SingleProduct$Outbound` instead. */
+  export type Outbound = SingleProduct$Outbound;
+}
+
+export function singleProductToJSON(singleProduct: SingleProduct): string {
+  return JSON.stringify(SingleProduct$outboundSchema.parse(singleProduct));
+}
+
+export function singleProductFromJSON(
+  jsonString: string,
+): SafeParseResult<SingleProduct, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SingleProduct$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SingleProduct' from JSON`,
+  );
+}

package/src/models/components/singleproductdetail.ts

@@ -0,0 +1,339 @@
+/*
+ * 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 {
+  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 {
+  Variant,
+  Variant$inboundSchema,
+  Variant$Outbound,
+  Variant$outboundSchema,
+} from "./variant.js";
+import {
+  VariantOption,
+  VariantOption$inboundSchema,
+  VariantOption$Outbound,
+  VariantOption$outboundSchema,
+} from "./variantoption.js";
+
+export const SingleProductDetailProductType = {
+  Physical: "physical",
+  Digital: "digital",
+  Bundle: "bundle",
+} as const;
+export type SingleProductDetailProductType = ClosedEnum<
+  typeof SingleProductDetailProductType
+>;
+
+export type SingleProductDetail = {
+  /**
+   * The ULID of the product
+   */
+  id: string;
+  sku?: string | undefined;
+  name: string;
+  slug: string;
+  shortDescription?: string | undefined;
+  productType: SingleProductDetailProductType;
+  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 | undefined;
+  /**
+   * this will be used if has_variant is true, to auto set default values.
+   */
+  variantOptions?: Array<VariantOption> | null | undefined;
+  promotion?: ProductPromotion | null | undefined;
+  images?: Array<ProductImage> | undefined;
+  subscription?: Array<ProductSubscription> | undefined;
+  variants?: Array<Variant> | 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 SingleProductDetailProductType$inboundSchema: z.ZodNativeEnum<
+  typeof SingleProductDetailProductType
+> = z.nativeEnum(SingleProductDetailProductType);
+
+/** @internal */
+export const SingleProductDetailProductType$outboundSchema: z.ZodNativeEnum<
+  typeof SingleProductDetailProductType
+> = SingleProductDetailProductType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SingleProductDetailProductType$ {
+  /** @deprecated use `SingleProductDetailProductType$inboundSchema` instead. */
+  export const inboundSchema = SingleProductDetailProductType$inboundSchema;
+  /** @deprecated use `SingleProductDetailProductType$outboundSchema` instead. */
+  export const outboundSchema = SingleProductDetailProductType$outboundSchema;
+}
+
+/** @internal */
+export const SingleProductDetail$inboundSchema: z.ZodType<
+  SingleProductDetail,
+  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: SingleProductDetailProductType$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.optional(),
+  variant_options: z.nullable(z.array(VariantOption$inboundSchema)).optional(),
+  promotion: z.nullable(ProductPromotion$inboundSchema).optional(),
+  images: z.array(ProductImage$inboundSchema).optional(),
+  subscription: z.array(ProductSubscription$inboundSchema).optional(),
+  variants: z.array(Variant$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",
+    "hsn_code": "hsnCode",
+    "upselling_product_ids": "upsellingProductIds",
+    "crossselling_product_ids": "crosssellingProductIds",
+  });
+});
+
+/** @internal */
+export type SingleProductDetail$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 | undefined;
+  variant_options?: Array<VariantOption$Outbound> | null | undefined;
+  promotion?: ProductPromotion$Outbound | null | undefined;
+  images?: Array<ProductImage$Outbound> | undefined;
+  subscription?: Array<ProductSubscription$Outbound> | undefined;
+  variants?: Array<Variant$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 SingleProductDetail$outboundSchema: z.ZodType<
+  SingleProductDetail$Outbound,
+  z.ZodTypeDef,
+  SingleProductDetail
+> = z.object({
+  id: z.string(),
+  sku: z.string().optional(),
+  name: z.string(),
+  slug: z.string(),
+  shortDescription: z.string().optional(),
+  productType: SingleProductDetailProductType$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.optional(),
+  variantOptions: z.nullable(z.array(VariantOption$outboundSchema)).optional(),
+  promotion: z.nullable(ProductPromotion$outboundSchema).optional(),
+  images: z.array(ProductImage$outboundSchema).optional(),
+  subscription: z.array(ProductSubscription$outboundSchema).optional(),
+  variants: z.array(Variant$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",
+    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 SingleProductDetail$ {
+  /** @deprecated use `SingleProductDetail$inboundSchema` instead. */
+  export const inboundSchema = SingleProductDetail$inboundSchema;
+  /** @deprecated use `SingleProductDetail$outboundSchema` instead. */
+  export const outboundSchema = SingleProductDetail$outboundSchema;
+  /** @deprecated use `SingleProductDetail$Outbound` instead. */
+  export type Outbound = SingleProductDetail$Outbound;
+}
+
+export function singleProductDetailToJSON(
+  singleProductDetail: SingleProductDetail,
+): string {
+  return JSON.stringify(
+    SingleProductDetail$outboundSchema.parse(singleProductDetail),
+  );
+}
+
+export function singleProductDetailFromJSON(
+  jsonString: string,
+): SafeParseResult<SingleProductDetail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SingleProductDetail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SingleProductDetail' from JSON`,
+  );
+}