ce-storefront 0.3.10 → 0.3.17

package/src/models/components/variant.ts

@@ -50,8 +50,8 @@ export type Variant = {
   /**
    * variant sku
    */
-  sku?: string | undefined;
-  slug?: string | undefined;
+  sku: string | null;
+  slug: string | null;
   /**
    * variant name
    */
@@ -60,7 +60,7 @@ export type Variant = {
    * variant name
    */
   productName: string;
-  shortDescription: string;
+  shortDescription: string | null;
   active: boolean;
   stockAvailable: boolean;
   /**
@@ -73,11 +73,14 @@ export type Variant = {
    * Indicates whether a variant is marked as the default variant for a product
    */
   isDefault: boolean;
+  /**
+   * An object where each key is an option name, and the value describes the option details.
+   */
   associatedOptions: { [k: string]: AssociatedOption };
-  images?: Array<ProductImage> | undefined;
+  images: Array<ProductImage>;
   pricing: ProductPricing;
-  subscription?: Array<ProductSubscription> | undefined;
-  promotion?: Array<ProductPromotion> | undefined;
+  subscription: Array<ProductSubscription>;
+  promotion: Array<ProductPromotion>;
 };
 
 /** @internal */
@@ -85,11 +88,11 @@ export const Variant$inboundSchema: z.ZodType<Variant, z.ZodTypeDef, unknown> =
   z.object({
     id: z.string(),
     product_id: z.string(),
-    sku: z.string().optional(),
-    slug: z.string().optional(),
+    sku: z.nullable(z.string()),
+    slug: z.nullable(z.string()),
     name: z.string(),
     product_name: z.string(),
-    short_description: z.string(),
+    short_description: z.nullable(z.string()),
     active: z.boolean(),
     stock_available: z.boolean(),
     on_offer: z.boolean().default(false),
@@ -97,10 +100,10 @@ export const Variant$inboundSchema: z.ZodType<Variant, z.ZodTypeDef, unknown> =
     on_subscription: z.boolean().default(false),
     is_default: z.boolean(),
     associated_options: z.record(AssociatedOption$inboundSchema),
-    images: z.array(ProductImage$inboundSchema).optional(),
+    images: z.array(ProductImage$inboundSchema),
     pricing: ProductPricing$inboundSchema,
-    subscription: z.array(ProductSubscription$inboundSchema).optional(),
-    promotion: z.array(ProductPromotion$inboundSchema).optional(),
+    subscription: z.array(ProductSubscription$inboundSchema),
+    promotion: z.array(ProductPromotion$inboundSchema),
   }).transform((v) => {
     return remap$(v, {
       "product_id": "productId",
@@ -119,11 +122,11 @@ export const Variant$inboundSchema: z.ZodType<Variant, z.ZodTypeDef, unknown> =
 export type Variant$Outbound = {
   id: string;
   product_id: string;
-  sku?: string | undefined;
-  slug?: string | undefined;
+  sku: string | null;
+  slug: string | null;
   name: string;
   product_name: string;
-  short_description: string;
+  short_description: string | null;
   active: boolean;
   stock_available: boolean;
   on_offer: boolean;
@@ -131,10 +134,10 @@ export type Variant$Outbound = {
   on_subscription: boolean;
   is_default: boolean;
   associated_options: { [k: string]: AssociatedOption$Outbound };
-  images?: Array<ProductImage$Outbound> | undefined;
+  images: Array<ProductImage$Outbound>;
   pricing: ProductPricing$Outbound;
-  subscription?: Array<ProductSubscription$Outbound> | undefined;
-  promotion?: Array<ProductPromotion$Outbound> | undefined;
+  subscription: Array<ProductSubscription$Outbound>;
+  promotion: Array<ProductPromotion$Outbound>;
 };
 
 /** @internal */
@@ -145,11 +148,11 @@ export const Variant$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   productId: z.string(),
-  sku: z.string().optional(),
-  slug: z.string().optional(),
+  sku: z.nullable(z.string()),
+  slug: z.nullable(z.string()),
   name: z.string(),
   productName: z.string(),
-  shortDescription: z.string(),
+  shortDescription: z.nullable(z.string()),
   active: z.boolean(),
   stockAvailable: z.boolean(),
   onOffer: z.boolean().default(false),
@@ -157,10 +160,10 @@ export const Variant$outboundSchema: z.ZodType<
   onSubscription: z.boolean().default(false),
   isDefault: z.boolean(),
   associatedOptions: z.record(AssociatedOption$outboundSchema),
-  images: z.array(ProductImage$outboundSchema).optional(),
+  images: z.array(ProductImage$outboundSchema),
   pricing: ProductPricing$outboundSchema,
-  subscription: z.array(ProductSubscription$outboundSchema).optional(),
-  promotion: z.array(ProductPromotion$outboundSchema).optional(),
+  subscription: z.array(ProductSubscription$outboundSchema),
+  promotion: z.array(ProductPromotion$outboundSchema),
 }).transform((v) => {
   return remap$(v, {
     productId: "product_id",

package/src/models/components/variantdetail.ts

@@ -90,8 +90,8 @@ export type VariantDetail = {
   /**
    * variant sku
    */
-  sku?: string | undefined;
-  slug?: string | undefined;
+  sku: string | null;
+  slug: string | null;
   /**
    * variant name
    */
@@ -100,7 +100,7 @@ export type VariantDetail = {
    * variant name
    */
   productName: string;
-  shortDescription: string;
+  shortDescription: string | null;
   active: boolean;
   stockAvailable: boolean;
   /**
@@ -113,25 +113,28 @@ export type VariantDetail = {
    * Indicates whether a variant is marked as the default variant for a product
    */
   isDefault: boolean;
+  /**
+   * An object where each key is an option name, and the value describes the option details.
+   */
   associatedOptions: { [k: string]: AssociatedOption };
-  images?: Array<ProductImage> | undefined;
+  images: Array<ProductImage>;
   pricing: ProductPricing;
-  subscription?: Array<ProductSubscription> | undefined;
-  promotion?: Array<ProductPromotion> | undefined;
+  subscription: Array<ProductSubscription>;
+  promotion: Array<ProductPromotion>;
   productType: VariantDetailProductType;
-  description?: string | undefined;
-  categoryIds?: Array<string> | undefined;
-  tags?: Array<string> | null | undefined;
-  reviewRatingSum?: number | undefined;
-  reviewsCount?: number | undefined;
-  hsnCode?: string | undefined;
+  description: string | null;
+  categoryIds: Array<string>;
+  tags: Array<string> | null;
+  reviewRatingSum: number | null;
+  reviewsCount: number;
+  hsnCode: string | null;
   variantOptions: Array<VariantOption>;
-  productAttributes?: Array<ProductAttribute> | undefined;
-  variantAttributes?: Array<ProductAttribute> | undefined;
-  videos?: Array<ProductVideo> | undefined;
-  shipping?: ProductShipping | null | undefined;
-  seo?: Seo | undefined;
-  metadata?: { [k: string]: string } | undefined;
+  productAttributes: Array<ProductAttribute>;
+  variantAttributes: Array<ProductAttribute>;
+  videos: Array<ProductVideo>;
+  shipping: ProductShipping | null;
+  seo: Seo;
+  metadata: { [k: string]: string };
 };
 
 /** @internal */
@@ -163,11 +166,11 @@ export const VariantDetail$inboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   product_id: z.string(),
-  sku: z.string().optional(),
-  slug: z.string().optional(),
+  sku: z.nullable(z.string()),
+  slug: z.nullable(z.string()),
   name: z.string(),
   product_name: z.string(),
-  short_description: z.string(),
+  short_description: z.nullable(z.string()),
   active: z.boolean(),
   stock_available: z.boolean(),
   on_offer: z.boolean().default(false),
@@ -175,24 +178,24 @@ export const VariantDetail$inboundSchema: z.ZodType<
   on_subscription: z.boolean().default(false),
   is_default: z.boolean(),
   associated_options: z.record(AssociatedOption$inboundSchema),
-  images: z.array(ProductImage$inboundSchema).optional(),
+  images: z.array(ProductImage$inboundSchema),
   pricing: ProductPricing$inboundSchema,
-  subscription: z.array(ProductSubscription$inboundSchema).optional(),
-  promotion: z.array(ProductPromotion$inboundSchema).optional(),
+  subscription: z.array(ProductSubscription$inboundSchema),
+  promotion: z.array(ProductPromotion$inboundSchema),
   product_type: VariantDetailProductType$inboundSchema,
-  description: z.string().optional(),
-  category_ids: z.array(z.string()).optional(),
-  tags: z.nullable(z.array(z.string())).optional(),
-  review_rating_sum: z.number().optional(),
-  reviews_count: z.number().int().optional(),
-  hsn_code: z.string().optional(),
+  description: z.nullable(z.string()),
+  category_ids: z.array(z.string()),
+  tags: z.nullable(z.array(z.string())),
+  review_rating_sum: z.nullable(z.number()),
+  reviews_count: z.number().int(),
+  hsn_code: z.nullable(z.string()),
   variant_options: z.array(VariantOption$inboundSchema),
-  product_attributes: z.array(ProductAttribute$inboundSchema).optional(),
-  variant_attributes: z.array(ProductAttribute$inboundSchema).optional(),
-  videos: z.array(ProductVideo$inboundSchema).optional(),
-  shipping: z.nullable(ProductShipping$inboundSchema).optional(),
-  seo: Seo$inboundSchema.optional(),
-  metadata: z.record(z.string()).optional(),
+  product_attributes: z.array(ProductAttribute$inboundSchema),
+  variant_attributes: z.array(ProductAttribute$inboundSchema),
+  videos: z.array(ProductVideo$inboundSchema),
+  shipping: z.nullable(ProductShipping$inboundSchema),
+  seo: Seo$inboundSchema,
+  metadata: z.record(z.string()),
 }).transform((v) => {
   return remap$(v, {
     "product_id": "productId",
@@ -219,11 +222,11 @@ export const VariantDetail$inboundSchema: z.ZodType<
 export type VariantDetail$Outbound = {
   id: string;
   product_id: string;
-  sku?: string | undefined;
-  slug?: string | undefined;
+  sku: string | null;
+  slug: string | null;
   name: string;
   product_name: string;
-  short_description: string;
+  short_description: string | null;
   active: boolean;
   stock_available: boolean;
   on_offer: boolean;
@@ -231,24 +234,24 @@ export type VariantDetail$Outbound = {
   on_subscription: boolean;
   is_default: boolean;
   associated_options: { [k: string]: AssociatedOption$Outbound };
-  images?: Array<ProductImage$Outbound> | undefined;
+  images: Array<ProductImage$Outbound>;
   pricing: ProductPricing$Outbound;
-  subscription?: Array<ProductSubscription$Outbound> | undefined;
-  promotion?: Array<ProductPromotion$Outbound> | undefined;
+  subscription: Array<ProductSubscription$Outbound>;
+  promotion: Array<ProductPromotion$Outbound>;
   product_type: string;
-  description?: string | undefined;
-  category_ids?: Array<string> | undefined;
-  tags?: Array<string> | null | undefined;
-  review_rating_sum?: number | undefined;
-  reviews_count?: number | undefined;
-  hsn_code?: string | undefined;
+  description: string | null;
+  category_ids: Array<string>;
+  tags: Array<string> | null;
+  review_rating_sum: number | null;
+  reviews_count: number;
+  hsn_code: string | null;
   variant_options: Array<VariantOption$Outbound>;
-  product_attributes?: Array<ProductAttribute$Outbound> | undefined;
-  variant_attributes?: Array<ProductAttribute$Outbound> | undefined;
-  videos?: Array<ProductVideo$Outbound> | undefined;
-  shipping?: ProductShipping$Outbound | null | undefined;
-  seo?: Seo$Outbound | undefined;
-  metadata?: { [k: string]: string } | undefined;
+  product_attributes: Array<ProductAttribute$Outbound>;
+  variant_attributes: Array<ProductAttribute$Outbound>;
+  videos: Array<ProductVideo$Outbound>;
+  shipping: ProductShipping$Outbound | null;
+  seo: Seo$Outbound;
+  metadata: { [k: string]: string };
 };
 
 /** @internal */
@@ -259,11 +262,11 @@ export const VariantDetail$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   productId: z.string(),
-  sku: z.string().optional(),
-  slug: z.string().optional(),
+  sku: z.nullable(z.string()),
+  slug: z.nullable(z.string()),
   name: z.string(),
   productName: z.string(),
-  shortDescription: z.string(),
+  shortDescription: z.nullable(z.string()),
   active: z.boolean(),
   stockAvailable: z.boolean(),
   onOffer: z.boolean().default(false),
@@ -271,24 +274,24 @@ export const VariantDetail$outboundSchema: z.ZodType<
   onSubscription: z.boolean().default(false),
   isDefault: z.boolean(),
   associatedOptions: z.record(AssociatedOption$outboundSchema),
-  images: z.array(ProductImage$outboundSchema).optional(),
+  images: z.array(ProductImage$outboundSchema),
   pricing: ProductPricing$outboundSchema,
-  subscription: z.array(ProductSubscription$outboundSchema).optional(),
-  promotion: z.array(ProductPromotion$outboundSchema).optional(),
+  subscription: z.array(ProductSubscription$outboundSchema),
+  promotion: z.array(ProductPromotion$outboundSchema),
   productType: VariantDetailProductType$outboundSchema,
-  description: z.string().optional(),
-  categoryIds: z.array(z.string()).optional(),
-  tags: z.nullable(z.array(z.string())).optional(),
-  reviewRatingSum: z.number().optional(),
-  reviewsCount: z.number().int().optional(),
-  hsnCode: z.string().optional(),
+  description: z.nullable(z.string()),
+  categoryIds: z.array(z.string()),
+  tags: z.nullable(z.array(z.string())),
+  reviewRatingSum: z.nullable(z.number()),
+  reviewsCount: z.number().int(),
+  hsnCode: z.nullable(z.string()),
   variantOptions: z.array(VariantOption$outboundSchema),
-  productAttributes: z.array(ProductAttribute$outboundSchema).optional(),
-  variantAttributes: z.array(ProductAttribute$outboundSchema).optional(),
-  videos: z.array(ProductVideo$outboundSchema).optional(),
-  shipping: z.nullable(ProductShipping$outboundSchema).optional(),
-  seo: Seo$outboundSchema.optional(),
-  metadata: z.record(z.string()).optional(),
+  productAttributes: z.array(ProductAttribute$outboundSchema),
+  variantAttributes: z.array(ProductAttribute$outboundSchema),
+  videos: z.array(ProductVideo$outboundSchema),
+  shipping: z.nullable(ProductShipping$outboundSchema),
+  seo: Seo$outboundSchema,
+  metadata: z.record(z.string()),
 }).transform((v) => {
   return remap$(v, {
     productId: "product_id",

package/src/models/components/variantoption.ts

@@ -3,25 +3,31 @@
  */
 
 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";
 
-export const OptionType = {
+export const Type = {
   SingleSelect: "single-select",
   Color: "color",
 } as const;
-export type OptionType = ClosedEnum<typeof OptionType>;
+export type Type = ClosedEnum<typeof Type>;
 
 export type Two = {};
 
-export type OptionValue = Two | string;
+export type Value = Two | string;
 
 export type VariantOption = {
-  optionName?: string | undefined;
-  optionType?: OptionType | undefined;
+  /**
+   * The name of the associated option.
+   */
+  name: string;
+  /**
+   * A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`
+   */
+  key: string;
+  type: Type;
   /**
    * When option_type is color, value will contain an array of objects like:
    *
@@ -39,26 +45,27 @@ export type VariantOption = {
    * ]
    * ```
    */
-  optionValue?: Array<Two | string> | undefined;
+  value: Array<Two | string>;
 };
 
 /** @internal */
-export const OptionType$inboundSchema: z.ZodNativeEnum<typeof OptionType> = z
-  .nativeEnum(OptionType);
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
 
 /** @internal */
-export const OptionType$outboundSchema: z.ZodNativeEnum<typeof OptionType> =
-  OptionType$inboundSchema;
+export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
+  Type$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace OptionType$ {
-  /** @deprecated use `OptionType$inboundSchema` instead. */
-  export const inboundSchema = OptionType$inboundSchema;
-  /** @deprecated use `OptionType$outboundSchema` instead. */
-  export const outboundSchema = OptionType$outboundSchema;
+export namespace Type$ {
+  /** @deprecated use `Type$inboundSchema` instead. */
+  export const inboundSchema = Type$inboundSchema;
+  /** @deprecated use `Type$outboundSchema` instead. */
+  export const outboundSchema = Type$outboundSchema;
 }
 
 /** @internal */
@@ -100,46 +107,43 @@ export function twoFromJSON(
 }
 
 /** @internal */
-export const OptionValue$inboundSchema: z.ZodType<
-  OptionValue,
-  z.ZodTypeDef,
-  unknown
-> = z.union([z.lazy(() => Two$inboundSchema), z.string()]);
+export const Value$inboundSchema: z.ZodType<Value, z.ZodTypeDef, unknown> = z
+  .union([z.lazy(() => Two$inboundSchema), z.string()]);
 
 /** @internal */
-export type OptionValue$Outbound = Two$Outbound | string;
+export type Value$Outbound = Two$Outbound | string;
 
 /** @internal */
-export const OptionValue$outboundSchema: z.ZodType<
-  OptionValue$Outbound,
+export const Value$outboundSchema: z.ZodType<
+  Value$Outbound,
   z.ZodTypeDef,
-  OptionValue
+  Value
 > = z.union([z.lazy(() => Two$outboundSchema), z.string()]);
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace OptionValue$ {
-  /** @deprecated use `OptionValue$inboundSchema` instead. */
-  export const inboundSchema = OptionValue$inboundSchema;
-  /** @deprecated use `OptionValue$outboundSchema` instead. */
-  export const outboundSchema = OptionValue$outboundSchema;
-  /** @deprecated use `OptionValue$Outbound` instead. */
-  export type Outbound = OptionValue$Outbound;
+export namespace Value$ {
+  /** @deprecated use `Value$inboundSchema` instead. */
+  export const inboundSchema = Value$inboundSchema;
+  /** @deprecated use `Value$outboundSchema` instead. */
+  export const outboundSchema = Value$outboundSchema;
+  /** @deprecated use `Value$Outbound` instead. */
+  export type Outbound = Value$Outbound;
 }
 
-export function optionValueToJSON(optionValue: OptionValue): string {
-  return JSON.stringify(OptionValue$outboundSchema.parse(optionValue));
+export function valueToJSON(value: Value): string {
+  return JSON.stringify(Value$outboundSchema.parse(value));
 }
 
-export function optionValueFromJSON(
+export function valueFromJSON(
   jsonString: string,
-): SafeParseResult<OptionValue, SDKValidationError> {
+): SafeParseResult<Value, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => OptionValue$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'OptionValue' from JSON`,
+    (x) => Value$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Value' from JSON`,
   );
 }
 
@@ -149,23 +153,18 @@ export const VariantOption$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  option_name: z.string().optional(),
-  option_type: OptionType$inboundSchema.optional(),
-  option_value: z.array(z.union([z.lazy(() => Two$inboundSchema), z.string()]))
-    .optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "option_name": "optionName",
-    "option_type": "optionType",
-    "option_value": "optionValue",
-  });
+  name: z.string(),
+  key: z.string(),
+  type: Type$inboundSchema,
+  value: z.array(z.union([z.lazy(() => Two$inboundSchema), z.string()])),
 });
 
 /** @internal */
 export type VariantOption$Outbound = {
-  option_name?: string | undefined;
-  option_type?: string | undefined;
-  option_value?: Array<Two$Outbound | string> | undefined;
+  name: string;
+  key: string;
+  type: string;
+  value: Array<Two$Outbound | string>;
 };
 
 /** @internal */
@@ -174,16 +173,10 @@ export const VariantOption$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   VariantOption
 > = z.object({
-  optionName: z.string().optional(),
-  optionType: OptionType$outboundSchema.optional(),
-  optionValue: z.array(z.union([z.lazy(() => Two$outboundSchema), z.string()]))
-    .optional(),
-}).transform((v) => {
-  return remap$(v, {
-    optionName: "option_name",
-    optionType: "option_type",
-    optionValue: "option_value",
-  });
+  name: z.string(),
+  key: z.string(),
+  type: Type$outboundSchema,
+  value: z.array(z.union([z.lazy(() => Two$outboundSchema), z.string()])),
 });
 
 /**

package/src/sdk/addresses.ts

@@ -2,50 +2,12 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { customersAddressesAdd } from "../funcs/customersAddressesAdd.js";
-import { customersAddressesDelete } from "../funcs/customersAddressesDelete.js";
-import { customersAddressesGet } from "../funcs/customersAddressesGet.js";
-import { customersAddressesList } from "../funcs/customersAddressesList.js";
-import { customersAddressesUpdate } from "../funcs/customersAddressesUpdate.js";
+import { addressesGet } from "../funcs/addressesGet.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Addresses extends ClientSDK {
-  /**
-   * Retrieve all addresses
-   *
-   * @remarks
-   * Retrieve billing and shipping address of particular customer
-   */
-  async list(
-    request: operations.GetAddressRequest,
-    options?: RequestOptions,
-  ): Promise<operations.GetAddressResponseBody> {
-    return unwrapAsync(customersAddressesList(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Add address
-   *
-   * @remarks
-   * Add new address
-   */
-  async add(
-    request: operations.PostAddressRequest,
-    options?: RequestOptions,
-  ): Promise<operations.PostAddressResponseBody> {
-    return unwrapAsync(customersAddressesAdd(
-      this,
-      request,
-      options,
-    ));
-  }
-
   /**
    * Retrieve particular address
    *
@@ -56,41 +18,7 @@ export class Addresses extends ClientSDK {
     request: operations.GetCustomerAddressIdRequest,
     options?: RequestOptions,
   ): Promise<operations.GetCustomerAddressIdResponseBody> {
-    return unwrapAsync(customersAddressesGet(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Update particular address
-   *
-   * @remarks
-   * Update address
-   */
-  async update(
-    request: operations.PutCustomerAddressIdRequest,
-    options?: RequestOptions,
-  ): Promise<operations.PutCustomerAddressIdResponseBody> {
-    return unwrapAsync(customersAddressesUpdate(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Remove particular address
-   *
-   * @remarks
-   * Delete address
-   */
-  async delete(
-    request: operations.DeleteCustomerAddressIdRequest,
-    options?: RequestOptions,
-  ): Promise<operations.DeleteCustomerAddressIdResponseBody> {
-    return unwrapAsync(customersAddressesDelete(
+    return unwrapAsync(addressesGet(
       this,
       request,
       options,