ce-storefront 0.3.5 → 0.3.7

package/src/models/components/sku.ts

@@ -0,0 +1,252 @@
+/*
+ * 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 SKUProductType = {
+  Physical: "physical",
+  Digital: "digital",
+  Bundle: "bundle",
+} as const;
+export type SKUProductType = ClosedEnum<typeof SKUProductType>;
+
+export type Sku = {
+  productId: string;
+  variantId?: string | null | undefined;
+  sku: string;
+  slug?: string | undefined;
+  productName: string;
+  variantName?: string | null | undefined;
+  productType: SKUProductType;
+  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;
+};
+
+/** @internal */
+export const SKUProductType$inboundSchema: z.ZodNativeEnum<
+  typeof SKUProductType
+> = z.nativeEnum(SKUProductType);
+
+/** @internal */
+export const SKUProductType$outboundSchema: z.ZodNativeEnum<
+  typeof SKUProductType
+> = SKUProductType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SKUProductType$ {
+  /** @deprecated use `SKUProductType$inboundSchema` instead. */
+  export const inboundSchema = SKUProductType$inboundSchema;
+  /** @deprecated use `SKUProductType$outboundSchema` instead. */
+  export const outboundSchema = SKUProductType$outboundSchema;
+}
+
+/** @internal */
+export const Sku$inboundSchema: z.ZodType<Sku, z.ZodTypeDef, unknown> = z
+  .object({
+    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: SKUProductType$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 Sku$Outbound = {
+  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 Sku$outboundSchema: z.ZodType<Sku$Outbound, z.ZodTypeDef, Sku> = z
+  .object({
+    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: SKUProductType$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 Sku$ {
+  /** @deprecated use `Sku$inboundSchema` instead. */
+  export const inboundSchema = Sku$inboundSchema;
+  /** @deprecated use `Sku$outboundSchema` instead. */
+  export const outboundSchema = Sku$outboundSchema;
+  /** @deprecated use `Sku$Outbound` instead. */
+  export type Outbound = Sku$Outbound;
+}
+
+export function skuToJSON(sku: Sku): string {
+  return JSON.stringify(Sku$outboundSchema.parse(sku));
+}
+
+export function skuFromJSON(
+  jsonString: string,
+): SafeParseResult<Sku, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Sku$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Sku' from JSON`,
+  );
+}

package/src/models/components/variant.ts

@@ -7,6 +7,12 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.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 {
   ProductImage,
   ProductImage$inboundSchema,
@@ -25,12 +31,6 @@ import {
   ProductPromotion$Outbound,
   ProductPromotion$outboundSchema,
 } from "./productpromotion.js";
-import {
-  ProductShipping,
-  ProductShipping$inboundSchema,
-  ProductShipping$Outbound,
-  ProductShipping$outboundSchema,
-} from "./productshipping.js";
 import {
   ProductSubscription,
   ProductSubscription$inboundSchema,
@@ -38,195 +38,103 @@ import {
   ProductSubscription$outboundSchema,
 } from "./productsubscription.js";
 
-export type AssociatedOptions = {};
-
-export type Metadata = {
-  key?: string | undefined;
-  value?: string | undefined;
-};
-
 export type Variant = {
   /**
    * variant id
    */
-  id?: string | undefined;
+  id: string;
   /**
-   * variant name
+   * product id
    */
-  name?: string | undefined;
+  productId: string;
   /**
    * variant sku
    */
   sku?: string | undefined;
   slug?: string | undefined;
-  active?: boolean | undefined;
+  /**
+   * variant name
+   */
+  name: string;
+  /**
+   * variant name
+   */
+  productName: string;
+  shortDescription: string;
+  active: boolean;
+  stockAvailable: boolean;
+  /**
+   * Indicates whether this item is associated with any active (product-specific) coupons
+   */
+  onOffer?: boolean | undefined;
   onPromotion?: boolean | undefined;
   onSubscription?: boolean | undefined;
-  associatedOptions?: AssociatedOptions | undefined;
-  stockAvailable?: boolean | undefined;
-  shortDescription?: string | undefined;
-  isDefault?: boolean | undefined;
+  /**
+   * Indicates whether a variant is marked as the default variant for a product
+   */
+  isDefault: boolean;
+  associatedOptions: { [k: string]: AssociatedOption };
   images?: Array<ProductImage> | undefined;
-  pricing?: ProductPricing | undefined;
+  pricing: ProductPricing;
   subscription?: Array<ProductSubscription> | undefined;
   promotion?: Array<ProductPromotion> | undefined;
-  shipping?: ProductShipping | undefined;
-  metadata?: Array<Metadata> | null | undefined;
-};
-
-/** @internal */
-export const AssociatedOptions$inboundSchema: z.ZodType<
-  AssociatedOptions,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-/** @internal */
-export type AssociatedOptions$Outbound = {};
-
-/** @internal */
-export const AssociatedOptions$outboundSchema: z.ZodType<
-  AssociatedOptions$Outbound,
-  z.ZodTypeDef,
-  AssociatedOptions
-> = z.object({});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace AssociatedOptions$ {
-  /** @deprecated use `AssociatedOptions$inboundSchema` instead. */
-  export const inboundSchema = AssociatedOptions$inboundSchema;
-  /** @deprecated use `AssociatedOptions$outboundSchema` instead. */
-  export const outboundSchema = AssociatedOptions$outboundSchema;
-  /** @deprecated use `AssociatedOptions$Outbound` instead. */
-  export type Outbound = AssociatedOptions$Outbound;
-}
-
-export function associatedOptionsToJSON(
-  associatedOptions: AssociatedOptions,
-): string {
-  return JSON.stringify(
-    AssociatedOptions$outboundSchema.parse(associatedOptions),
-  );
-}
-
-export function associatedOptionsFromJSON(
-  jsonString: string,
-): SafeParseResult<AssociatedOptions, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => AssociatedOptions$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'AssociatedOptions' from JSON`,
-  );
-}
-
-/** @internal */
-export const Metadata$inboundSchema: z.ZodType<
-  Metadata,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  key: z.string().optional(),
-  value: z.string().optional(),
-});
-
-/** @internal */
-export type Metadata$Outbound = {
-  key?: string | undefined;
-  value?: string | undefined;
 };
 
-/** @internal */
-export const Metadata$outboundSchema: z.ZodType<
-  Metadata$Outbound,
-  z.ZodTypeDef,
-  Metadata
-> = z.object({
-  key: z.string().optional(),
-  value: z.string().optional(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Metadata$ {
-  /** @deprecated use `Metadata$inboundSchema` instead. */
-  export const inboundSchema = Metadata$inboundSchema;
-  /** @deprecated use `Metadata$outboundSchema` instead. */
-  export const outboundSchema = Metadata$outboundSchema;
-  /** @deprecated use `Metadata$Outbound` instead. */
-  export type Outbound = Metadata$Outbound;
-}
-
-export function metadataToJSON(metadata: Metadata): string {
-  return JSON.stringify(Metadata$outboundSchema.parse(metadata));
-}
-
-export function metadataFromJSON(
-  jsonString: string,
-): SafeParseResult<Metadata, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Metadata' from JSON`,
-  );
-}
-
 /** @internal */
 export const Variant$inboundSchema: z.ZodType<Variant, z.ZodTypeDef, unknown> =
   z.object({
-    id: z.string().optional(),
-    name: z.string().optional(),
+    id: z.string(),
+    product_id: z.string(),
     sku: z.string().optional(),
     slug: z.string().optional(),
-    active: z.boolean().optional(),
-    on_promotion: z.boolean().optional(),
-    on_subscription: z.boolean().optional(),
-    associated_options: z.lazy(() => AssociatedOptions$inboundSchema)
-      .optional(),
-    stock_available: z.boolean().optional(),
-    short_description: z.string().optional(),
-    is_default: z.boolean().optional(),
+    name: z.string(),
+    product_name: z.string(),
+    short_description: z.string(),
+    active: z.boolean(),
+    stock_available: z.boolean(),
+    on_offer: z.boolean().default(false),
+    on_promotion: z.boolean().default(false),
+    on_subscription: z.boolean().default(false),
+    is_default: z.boolean(),
+    associated_options: z.record(AssociatedOption$inboundSchema),
     images: z.array(ProductImage$inboundSchema).optional(),
-    pricing: ProductPricing$inboundSchema.optional(),
+    pricing: ProductPricing$inboundSchema,
     subscription: z.array(ProductSubscription$inboundSchema).optional(),
     promotion: z.array(ProductPromotion$inboundSchema).optional(),
-    shipping: ProductShipping$inboundSchema.optional(),
-    metadata: z.nullable(z.array(z.lazy(() => Metadata$inboundSchema)))
-      .optional(),
   }).transform((v) => {
     return remap$(v, {
+      "product_id": "productId",
+      "product_name": "productName",
+      "short_description": "shortDescription",
+      "stock_available": "stockAvailable",
+      "on_offer": "onOffer",
       "on_promotion": "onPromotion",
       "on_subscription": "onSubscription",
-      "associated_options": "associatedOptions",
-      "stock_available": "stockAvailable",
-      "short_description": "shortDescription",
       "is_default": "isDefault",
+      "associated_options": "associatedOptions",
     });
   });
 
 /** @internal */
 export type Variant$Outbound = {
-  id?: string | undefined;
-  name?: string | undefined;
+  id: string;
+  product_id: string;
   sku?: string | undefined;
   slug?: string | undefined;
-  active?: boolean | undefined;
-  on_promotion?: boolean | undefined;
-  on_subscription?: boolean | undefined;
-  associated_options?: AssociatedOptions$Outbound | undefined;
-  stock_available?: boolean | undefined;
-  short_description?: string | undefined;
-  is_default?: boolean | undefined;
+  name: string;
+  product_name: string;
+  short_description: string;
+  active: boolean;
+  stock_available: boolean;
+  on_offer: boolean;
+  on_promotion: boolean;
+  on_subscription: boolean;
+  is_default: boolean;
+  associated_options: { [k: string]: AssociatedOption$Outbound };
   images?: Array<ProductImage$Outbound> | undefined;
-  pricing?: ProductPricing$Outbound | undefined;
+  pricing: ProductPricing$Outbound;
   subscription?: Array<ProductSubscription$Outbound> | undefined;
   promotion?: Array<ProductPromotion$Outbound> | undefined;
-  shipping?: ProductShipping$Outbound | undefined;
-  metadata?: Array<Metadata$Outbound> | null | undefined;
 };
 
 /** @internal */
@@ -235,32 +143,35 @@ export const Variant$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Variant
 > = z.object({
-  id: z.string().optional(),
-  name: z.string().optional(),
+  id: z.string(),
+  productId: z.string(),
   sku: z.string().optional(),
   slug: z.string().optional(),
-  active: z.boolean().optional(),
-  onPromotion: z.boolean().optional(),
-  onSubscription: z.boolean().optional(),
-  associatedOptions: z.lazy(() => AssociatedOptions$outboundSchema).optional(),
-  stockAvailable: z.boolean().optional(),
-  shortDescription: z.string().optional(),
-  isDefault: z.boolean().optional(),
+  name: z.string(),
+  productName: z.string(),
+  shortDescription: z.string(),
+  active: z.boolean(),
+  stockAvailable: z.boolean(),
+  onOffer: z.boolean().default(false),
+  onPromotion: z.boolean().default(false),
+  onSubscription: z.boolean().default(false),
+  isDefault: z.boolean(),
+  associatedOptions: z.record(AssociatedOption$outboundSchema),
   images: z.array(ProductImage$outboundSchema).optional(),
-  pricing: ProductPricing$outboundSchema.optional(),
+  pricing: ProductPricing$outboundSchema,
   subscription: z.array(ProductSubscription$outboundSchema).optional(),
   promotion: z.array(ProductPromotion$outboundSchema).optional(),
-  shipping: ProductShipping$outboundSchema.optional(),
-  metadata: z.nullable(z.array(z.lazy(() => Metadata$outboundSchema)))
-    .optional(),
 }).transform((v) => {
   return remap$(v, {
+    productId: "product_id",
+    productName: "product_name",
+    shortDescription: "short_description",
+    stockAvailable: "stock_available",
+    onOffer: "on_offer",
     onPromotion: "on_promotion",
     onSubscription: "on_subscription",
-    associatedOptions: "associated_options",
-    stockAvailable: "stock_available",
-    shortDescription: "short_description",
     isDefault: "is_default",
+    associatedOptions: "associated_options",
   });
 });