ce-storefront 0.3.9 → 0.3.11

package/src/models/components/updatecartitem.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Schema for updating a cart item, including adding, removing, or adjusting the quantity of a product or variant.
+ */
+export type UpdateCartItem = {
+  /**
+   * The ID of the product to update in the cart.
+   */
+  productId: string;
+  /**
+   * The ID of the product variant, or null if the product has no variants.
+   */
+  variantId: string | null;
+  /**
+   * The quantity of the product to add to or update in the cart. Use `0` to remove the item from the cart.
+   */
+  quantity: number;
+};
+
+/** @internal */
+export const UpdateCartItem$inboundSchema: z.ZodType<
+  UpdateCartItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  product_id: z.string(),
+  variant_id: z.nullable(z.string()),
+  quantity: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "product_id": "productId",
+    "variant_id": "variantId",
+  });
+});
+
+/** @internal */
+export type UpdateCartItem$Outbound = {
+  product_id: string;
+  variant_id: string | null;
+  quantity: number;
+};
+
+/** @internal */
+export const UpdateCartItem$outboundSchema: z.ZodType<
+  UpdateCartItem$Outbound,
+  z.ZodTypeDef,
+  UpdateCartItem
+> = z.object({
+  productId: z.string(),
+  variantId: z.nullable(z.string()),
+  quantity: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    productId: "product_id",
+    variantId: "variant_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateCartItem$ {
+  /** @deprecated use `UpdateCartItem$inboundSchema` instead. */
+  export const inboundSchema = UpdateCartItem$inboundSchema;
+  /** @deprecated use `UpdateCartItem$outboundSchema` instead. */
+  export const outboundSchema = UpdateCartItem$outboundSchema;
+  /** @deprecated use `UpdateCartItem$Outbound` instead. */
+  export type Outbound = UpdateCartItem$Outbound;
+}
+
+export function updateCartItemToJSON(updateCartItem: UpdateCartItem): string {
+  return JSON.stringify(UpdateCartItem$outboundSchema.parse(updateCartItem));
+}
+
+export function updateCartItemFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateCartItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateCartItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateCartItem' from JSON`,
+  );
+}

package/src/models/components/user.ts

@@ -5,6 +5,7 @@
 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 {
@@ -14,6 +15,14 @@ import {
   NotificationPreferences$outboundSchema,
 } from "./notificationpreferences.js";
 
+export const LoginMethods = {
+  Email: "email",
+  Phone: "phone",
+  Whatsapp: "whatsapp",
+  Password: "password",
+} as const;
+export type LoginMethods = ClosedEnum<typeof LoginMethods>;
+
 export type User = {
   /**
    * The unique identifier (ULID) of the user.
@@ -22,42 +31,51 @@ export type User = {
   /**
    * User’s first name.
    */
-  firstName?: string | undefined;
+  firstName: string;
   /**
    * User’s last name.
    */
-  lastName?: string | undefined;
+  lastName: string;
   /**
    * User’s email I’d.
    */
-  email?: string | undefined;
+  email: string;
   /**
    * Boolean indicating whether the email is verified.
    */
-  isEmailVerified?: boolean | undefined;
+  isEmailVerified: boolean;
   /**
    * 10 digit phone number without country code.
    */
-  phone?: string | undefined;
+  phone: string;
   /**
    * Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
    *
    * @remarks
    * Use this key along with phone. Not necessary for email.
    */
-  countryCode?: string | undefined;
+  countryCode: string;
   /**
    * Boolean indicating whether the phone is verified.
    */
-  isPhoneVerified?: boolean | undefined;
+  isPhoneVerified: boolean;
   /**
    * URL to the user's profile image.
    */
-  profileImageUrl?: string | undefined;
+  profileImageUrl: string;
+  /**
+   * Indicates whether the user is anonymous.
+   */
+  isAnonymous: boolean;
+  /**
+   * Indicates whether the user is currently logged in.
+   */
+  isLoggedIn: boolean;
+  loginMethods: Array<LoginMethods>;
   /**
    * Set channel preferences for each type of
    */
-  notificationPreferences?: NotificationPreferences | undefined;
+  notificationPreferences: NotificationPreferences;
   /**
    * Timestamps indicate when the user's account was created.
    */
@@ -66,35 +84,76 @@ export type User = {
    * Timestamps indicating when the user account was last modified.
    */
   modifiedAt?: string | undefined;
+};
+
+export type UserInput = {
   /**
-   * Indicates whether the user is anonymous.
+   * User’s first name.
    */
-  isAnonymous?: boolean | undefined;
+  firstName: string;
   /**
-   * Indicates whether the user is currently logged in.
+   * User’s last name.
+   */
+  lastName: string;
+  /**
+   * User’s email I’d.
+   */
+  email: string;
+  /**
+   * 10 digit phone number without country code.
    */
-  isLoggedIn?: boolean | undefined;
-  loginMethods?: Array<string> | undefined;
+  phone: string;
+  /**
+   * Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
+   *
+   * @remarks
+   * Use this key along with phone. Not necessary for email.
+   */
+  countryCode: string;
+  loginMethods: Array<LoginMethods>;
+  /**
+   * Set channel preferences for each type of
+   */
+  notificationPreferences: NotificationPreferences;
 };
 
+/** @internal */
+export const LoginMethods$inboundSchema: z.ZodNativeEnum<typeof LoginMethods> =
+  z.nativeEnum(LoginMethods);
+
+/** @internal */
+export const LoginMethods$outboundSchema: z.ZodNativeEnum<typeof LoginMethods> =
+  LoginMethods$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LoginMethods$ {
+  /** @deprecated use `LoginMethods$inboundSchema` instead. */
+  export const inboundSchema = LoginMethods$inboundSchema;
+  /** @deprecated use `LoginMethods$outboundSchema` instead. */
+  export const outboundSchema = LoginMethods$outboundSchema;
+}
+
 /** @internal */
 export const User$inboundSchema: z.ZodType<User, z.ZodTypeDef, unknown> = z
   .object({
     id: z.string(),
-    first_name: z.string().optional(),
-    last_name: z.string().optional(),
-    email: z.string().optional(),
-    is_email_verified: z.boolean().optional(),
-    phone: z.string().optional(),
-    country_code: z.string().optional(),
-    is_phone_verified: z.boolean().optional(),
-    profile_image_url: z.string().optional(),
-    notification_preferences: NotificationPreferences$inboundSchema.optional(),
+    first_name: z.string(),
+    last_name: z.string(),
+    email: z.string(),
+    is_email_verified: z.boolean(),
+    phone: z.string(),
+    country_code: z.string(),
+    is_phone_verified: z.boolean(),
+    profile_image_url: z.string(),
+    is_anonymous: z.boolean(),
+    is_logged_in: z.boolean(),
+    login_methods: z.array(LoginMethods$inboundSchema),
+    notification_preferences: NotificationPreferences$inboundSchema,
     created_at: z.string().optional(),
     modified_at: z.string().optional(),
-    is_anonymous: z.boolean().optional(),
-    is_logged_in: z.boolean().optional(),
-    login_methods: z.array(z.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
       "first_name": "firstName",
@@ -103,52 +162,52 @@ export const User$inboundSchema: z.ZodType<User, z.ZodTypeDef, unknown> = z
       "country_code": "countryCode",
       "is_phone_verified": "isPhoneVerified",
       "profile_image_url": "profileImageUrl",
-      "notification_preferences": "notificationPreferences",
-      "created_at": "createdAt",
-      "modified_at": "modifiedAt",
       "is_anonymous": "isAnonymous",
       "is_logged_in": "isLoggedIn",
       "login_methods": "loginMethods",
+      "notification_preferences": "notificationPreferences",
+      "created_at": "createdAt",
+      "modified_at": "modifiedAt",
     });
   });
 
 /** @internal */
 export type User$Outbound = {
   id: string;
-  first_name?: string | undefined;
-  last_name?: string | undefined;
-  email?: string | undefined;
-  is_email_verified?: boolean | undefined;
-  phone?: string | undefined;
-  country_code?: string | undefined;
-  is_phone_verified?: boolean | undefined;
-  profile_image_url?: string | undefined;
-  notification_preferences?: NotificationPreferences$Outbound | undefined;
+  first_name: string;
+  last_name: string;
+  email: string;
+  is_email_verified: boolean;
+  phone: string;
+  country_code: string;
+  is_phone_verified: boolean;
+  profile_image_url: string;
+  is_anonymous: boolean;
+  is_logged_in: boolean;
+  login_methods: Array<string>;
+  notification_preferences: NotificationPreferences$Outbound;
   created_at?: string | undefined;
   modified_at?: string | undefined;
-  is_anonymous?: boolean | undefined;
-  is_logged_in?: boolean | undefined;
-  login_methods?: Array<string> | undefined;
 };
 
 /** @internal */
 export const User$outboundSchema: z.ZodType<User$Outbound, z.ZodTypeDef, User> =
   z.object({
     id: z.string(),
-    firstName: z.string().optional(),
-    lastName: z.string().optional(),
-    email: z.string().optional(),
-    isEmailVerified: z.boolean().optional(),
-    phone: z.string().optional(),
-    countryCode: z.string().optional(),
-    isPhoneVerified: z.boolean().optional(),
-    profileImageUrl: z.string().optional(),
-    notificationPreferences: NotificationPreferences$outboundSchema.optional(),
+    firstName: z.string(),
+    lastName: z.string(),
+    email: z.string(),
+    isEmailVerified: z.boolean(),
+    phone: z.string(),
+    countryCode: z.string(),
+    isPhoneVerified: z.boolean(),
+    profileImageUrl: z.string(),
+    isAnonymous: z.boolean(),
+    isLoggedIn: z.boolean(),
+    loginMethods: z.array(LoginMethods$outboundSchema),
+    notificationPreferences: NotificationPreferences$outboundSchema,
     createdAt: z.string().optional(),
     modifiedAt: z.string().optional(),
-    isAnonymous: z.boolean().optional(),
-    isLoggedIn: z.boolean().optional(),
-    loginMethods: z.array(z.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
       firstName: "first_name",
@@ -157,12 +216,12 @@ export const User$outboundSchema: z.ZodType<User$Outbound, z.ZodTypeDef, User> =
       countryCode: "country_code",
       isPhoneVerified: "is_phone_verified",
       profileImageUrl: "profile_image_url",
-      notificationPreferences: "notification_preferences",
-      createdAt: "created_at",
-      modifiedAt: "modified_at",
       isAnonymous: "is_anonymous",
       isLoggedIn: "is_logged_in",
       loginMethods: "login_methods",
+      notificationPreferences: "notification_preferences",
+      createdAt: "created_at",
+      modifiedAt: "modified_at",
     });
   });
 
@@ -192,3 +251,87 @@ export function userFromJSON(
     `Failed to parse 'User' from JSON`,
   );
 }
+
+/** @internal */
+export const UserInput$inboundSchema: z.ZodType<
+  UserInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  first_name: z.string(),
+  last_name: z.string(),
+  email: z.string(),
+  phone: z.string(),
+  country_code: z.string(),
+  login_methods: z.array(LoginMethods$inboundSchema),
+  notification_preferences: NotificationPreferences$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "first_name": "firstName",
+    "last_name": "lastName",
+    "country_code": "countryCode",
+    "login_methods": "loginMethods",
+    "notification_preferences": "notificationPreferences",
+  });
+});
+
+/** @internal */
+export type UserInput$Outbound = {
+  first_name: string;
+  last_name: string;
+  email: string;
+  phone: string;
+  country_code: string;
+  login_methods: Array<string>;
+  notification_preferences: NotificationPreferences$Outbound;
+};
+
+/** @internal */
+export const UserInput$outboundSchema: z.ZodType<
+  UserInput$Outbound,
+  z.ZodTypeDef,
+  UserInput
+> = z.object({
+  firstName: z.string(),
+  lastName: z.string(),
+  email: z.string(),
+  phone: z.string(),
+  countryCode: z.string(),
+  loginMethods: z.array(LoginMethods$outboundSchema),
+  notificationPreferences: NotificationPreferences$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    firstName: "first_name",
+    lastName: "last_name",
+    countryCode: "country_code",
+    loginMethods: "login_methods",
+    notificationPreferences: "notification_preferences",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UserInput$ {
+  /** @deprecated use `UserInput$inboundSchema` instead. */
+  export const inboundSchema = UserInput$inboundSchema;
+  /** @deprecated use `UserInput$outboundSchema` instead. */
+  export const outboundSchema = UserInput$outboundSchema;
+  /** @deprecated use `UserInput$Outbound` instead. */
+  export type Outbound = UserInput$Outbound;
+}
+
+export function userInputToJSON(userInput: UserInput): string {
+  return JSON.stringify(UserInput$outboundSchema.parse(userInput));
+}
+
+export function userInputFromJSON(
+  jsonString: string,
+): SafeParseResult<UserInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserInput' from JSON`,
+  );
+}

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",