ce-storefront 0.3.17 → 0.4.0

package/src/models/components/singleproductdetail.ts

@@ -88,27 +88,27 @@ export type SingleProductDetail = {
   slug: string | null;
   shortDescription: string | null;
   productType: SingleProductDetailProductType;
-  active?: boolean | undefined;
+  active: boolean;
   /**
    * Indicates whether the product has stock available
    */
-  stockAvailable?: boolean | undefined;
+  stockAvailable: boolean;
   /**
    * Indicates whether this item is associated with any active (product-specific) coupons
    */
-  onOffer?: boolean | undefined;
+  onOffer: boolean;
   /**
    * Indicates whether the product has any subscription plans avaialble
    */
-  onSubscription?: boolean | undefined;
+  onSubscription: boolean;
   /**
    * Indicates whether the product is currently on promotion. When true, the `ProductPromotion` object will contain details of the promotion
    */
-  onPromotion?: boolean | undefined;
+  onPromotion: boolean;
   /**
    * Indicates whether the product has variants
    */
-  hasVariant?: boolean | undefined;
+  hasVariant: boolean;
   tags: Array<string> | null;
   categoryIds: Array<string>;
   reviewsRatingSum: number;
@@ -172,12 +172,12 @@ export const SingleProductDetail$inboundSchema: z.ZodType<
   slug: z.nullable(z.string()),
   short_description: z.nullable(z.string()),
   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),
+  active: z.boolean(),
+  stock_available: z.boolean(),
+  on_offer: z.boolean(),
+  on_subscription: z.boolean(),
+  on_promotion: z.boolean(),
+  has_variant: z.boolean(),
   tags: z.nullable(z.array(z.string())),
   category_ids: z.array(z.string()),
   reviews_rating_sum: z.number(),
@@ -263,12 +263,12 @@ export const SingleProductDetail$outboundSchema: z.ZodType<
   slug: z.nullable(z.string()),
   shortDescription: z.nullable(z.string()),
   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),
+  active: z.boolean(),
+  stockAvailable: z.boolean(),
+  onOffer: z.boolean(),
+  onSubscription: z.boolean(),
+  onPromotion: z.boolean(),
+  hasVariant: z.boolean(),
   tags: z.nullable(z.array(z.string())),
   categoryIds: z.array(z.string()),
   reviewsRatingSum: z.number(),

package/src/models/components/sku.ts

@@ -61,14 +61,14 @@ export type Sku = {
   variantName: string | null;
   productType: SKUProductType;
   shortDescription: string | null;
-  active?: boolean | undefined;
-  stockAvailable?: boolean | undefined;
+  active: boolean;
+  stockAvailable: boolean;
   /**
    * Indicates whether this item is associated with any active (product-specific) coupons
    */
-  onOffer?: boolean | undefined;
-  onSubscription?: boolean | undefined;
-  onPromotion?: boolean | undefined;
+  onOffer: boolean;
+  onSubscription: boolean;
+  onPromotion: boolean;
   categoryIds: Array<string>;
   tags: Array<string> | null;
   reviewsCount: number;
@@ -113,11 +113,11 @@ export const Sku$inboundSchema: z.ZodType<Sku, z.ZodTypeDef, unknown> = z
     variant_name: z.nullable(z.string()),
     product_type: SKUProductType$inboundSchema,
     short_description: z.nullable(z.string()),
-    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),
+    active: z.boolean(),
+    stock_available: z.boolean(),
+    on_offer: z.boolean(),
+    on_subscription: z.boolean(),
+    on_promotion: z.boolean(),
     category_ids: z.array(z.string()),
     tags: z.nullable(z.array(z.string())),
     reviews_count: z.number().int(),
@@ -185,11 +185,11 @@ export const Sku$outboundSchema: z.ZodType<Sku$Outbound, z.ZodTypeDef, Sku> = z
     variantName: z.nullable(z.string()),
     productType: SKUProductType$outboundSchema,
     shortDescription: z.nullable(z.string()),
-    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),
+    active: z.boolean(),
+    stockAvailable: z.boolean(),
+    onOffer: z.boolean(),
+    onSubscription: z.boolean(),
+    onPromotion: z.boolean(),
     categoryIds: z.array(z.string()),
     tags: z.nullable(z.array(z.string())),
     reviewsCount: z.number().int(),

package/src/models/components/variant.ts

@@ -66,9 +66,9 @@ export type Variant = {
   /**
    * Indicates whether this item is associated with any active (product-specific) coupons
    */
-  onOffer?: boolean | undefined;
-  onPromotion?: boolean | undefined;
-  onSubscription?: boolean | undefined;
+  onOffer: boolean;
+  onPromotion: boolean;
+  onSubscription: boolean;
   /**
    * Indicates whether a variant is marked as the default variant for a product
    */
@@ -95,9 +95,9 @@ export const Variant$inboundSchema: z.ZodType<Variant, z.ZodTypeDef, unknown> =
     short_description: z.nullable(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),
+    on_offer: z.boolean(),
+    on_promotion: z.boolean(),
+    on_subscription: z.boolean(),
     is_default: z.boolean(),
     associated_options: z.record(AssociatedOption$inboundSchema),
     images: z.array(ProductImage$inboundSchema),
@@ -155,9 +155,9 @@ export const Variant$outboundSchema: z.ZodType<
   shortDescription: z.nullable(z.string()),
   active: z.boolean(),
   stockAvailable: z.boolean(),
-  onOffer: z.boolean().default(false),
-  onPromotion: z.boolean().default(false),
-  onSubscription: z.boolean().default(false),
+  onOffer: z.boolean(),
+  onPromotion: z.boolean(),
+  onSubscription: z.boolean(),
   isDefault: z.boolean(),
   associatedOptions: z.record(AssociatedOption$outboundSchema),
   images: z.array(ProductImage$outboundSchema),

package/src/models/components/variantdetail.ts

@@ -106,9 +106,9 @@ export type VariantDetail = {
   /**
    * Indicates whether this item is associated with any active (product-specific) coupons
    */
-  onOffer?: boolean | undefined;
-  onPromotion?: boolean | undefined;
-  onSubscription?: boolean | undefined;
+  onOffer: boolean;
+  onPromotion: boolean;
+  onSubscription: boolean;
   /**
    * Indicates whether a variant is marked as the default variant for a product
    */
@@ -173,9 +173,9 @@ export const VariantDetail$inboundSchema: z.ZodType<
   short_description: z.nullable(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),
+  on_offer: z.boolean(),
+  on_promotion: z.boolean(),
+  on_subscription: z.boolean(),
   is_default: z.boolean(),
   associated_options: z.record(AssociatedOption$inboundSchema),
   images: z.array(ProductImage$inboundSchema),
@@ -269,9 +269,9 @@ export const VariantDetail$outboundSchema: z.ZodType<
   shortDescription: z.nullable(z.string()),
   active: z.boolean(),
   stockAvailable: z.boolean(),
-  onOffer: z.boolean().default(false),
-  onPromotion: z.boolean().default(false),
-  onSubscription: z.boolean().default(false),
+  onOffer: z.boolean(),
+  onPromotion: z.boolean(),
+  onSubscription: z.boolean(),
   isDefault: z.boolean(),
   associatedOptions: z.record(AssociatedOption$outboundSchema),
   images: z.array(ProductImage$outboundSchema),

package/src/sdk/addresses.ts

@@ -2,12 +2,50 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { addressesGet } from "../funcs/addressesGet.js";
+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 { 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
    *
@@ -18,7 +56,41 @@ export class Addresses extends ClientSDK {
     request: operations.GetCustomerAddressIdRequest,
     options?: RequestOptions,
   ): Promise<operations.GetCustomerAddressIdResponseBody> {
-    return unwrapAsync(addressesGet(
+    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(
       this,
       request,
       options,

package/src/sdk/auth.ts

@@ -8,7 +8,6 @@ import { authLoginWithEmail } from "../funcs/authLoginWithEmail.js";
 import { authLoginWithPassword } from "../funcs/authLoginWithPassword.js";
 import { authLoginWithPhone } from "../funcs/authLoginWithPhone.js";
 import { authLoginWithWhatsapp } from "../funcs/authLoginWithWhatsapp.js";
-import { authLogout } from "../funcs/authLogout.js";
 import { authRefreshToken } from "../funcs/authRefreshToken.js";
 import { authRegisterWithEmail } from "../funcs/authRegisterWithEmail.js";
 import { authRegisterWithPassword } from "../funcs/authRegisterWithPassword.js";
@@ -20,14 +19,8 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 import { CeStorefrontUser } from "./cestorefrontuser.js";
-import { CeStorefrontUsers } from "./cestorefrontusers.js";
 
 export class Auth extends ClientSDK {
-  private _users?: CeStorefrontUsers;
-  get users(): CeStorefrontUsers {
-    return (this._users ??= new CeStorefrontUsers(this._options));
-  }
-
   private _user?: CeStorefrontUser;
   get user(): CeStorefrontUser {
     return (this._user ??= new CeStorefrontUser(this._options));
@@ -241,21 +234,6 @@ export class Auth extends ClientSDK {
     ));
   }
 
-  /**
-   * Logout user
-   *
-   * @remarks
-   * The Logout User API initiate the logout process for a user. Upon a successful request, the API responds with a confirmation message. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.
-   */
-  async logout(
-    options?: RequestOptions,
-  ): Promise<operations.PostAuthLogoutResponseBody> {
-    return unwrapAsync(authLogout(
-      this,
-      options,
-    ));
-  }
-
   /**
    * Check verified email phone
    *

package/src/sdk/catalog.ts

@@ -4,12 +4,18 @@
 
 import { ClientSDK } from "../lib/sdks.js";
 import { Categories } from "./categories.js";
-import { CeStorefrontProducts } from "./cestorefrontproducts.js";
+import { Products } from "./products.js";
+import { Skus } from "./skus.js";
 
 export class Catalog extends ClientSDK {
-  private _products?: CeStorefrontProducts;
-  get products(): CeStorefrontProducts {
-    return (this._products ??= new CeStorefrontProducts(this._options));
+  private _products?: Products;
+  get products(): Products {
+    return (this._products ??= new Products(this._options));
+  }
+
+  private _skus?: Skus;
+  get skus(): Skus {
+    return (this._skus ??= new Skus(this._options));
   }
 
   private _categories?: Categories;

package/src/sdk/cestorefrontreviews.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { catalogProductsReviewsCreate } from "../funcs/catalogProductsReviewsCreate.js";
+import { catalogProductsReviewsList } from "../funcs/catalogProductsReviewsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class CeStorefrontReviews extends ClientSDK {
+  /**
+   * List all product reviews
+   *
+   * @remarks
+   * List of reviews for a specified product. The reviews are returned sorted by submission date, with the most recent reviews appearing first. You can filter the reviews by rating, reviewer, or date for more detailed analysis.
+   */
+  async list(
+    request: operations.GetProductsIdReviewsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetProductsIdReviewsResponseBody> {
+    return unwrapAsync(catalogProductsReviewsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create product review
+   *
+   * @remarks
+   * Create a product review
+   */
+  async create(
+    request: operations.PostProductsIdReviewsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostProductsIdReviewsResponseBody> {
+    return unwrapAsync(catalogProductsReviewsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/cestorefrontuser.ts

@@ -2,18 +2,121 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { authUserAddProfileImage } from "../funcs/authUserAddProfileImage.js";
 import { authUserChangePassword } from "../funcs/authUserChangePassword.js";
-import { authUserDeactivate } from "../funcs/authUserDeactivate.js";
+import { authUserDeactivateAccount } from "../funcs/authUserDeactivateAccount.js";
+import { authUserDeleteProfileImage } from "../funcs/authUserDeleteProfileImage.js";
+import { authUserForgotPassword } from "../funcs/authUserForgotPassword.js";
+import { authUserGet } from "../funcs/authUserGet.js";
+import { authUserGetProfileImage } from "../funcs/authUserGetProfileImage.js";
+import { authUserLogout } from "../funcs/authUserLogout.js";
+import { authUserResetPassword } from "../funcs/authUserResetPassword.js";
+import { authUserUpdate } from "../funcs/authUserUpdate.js";
+import { authUserUpdateProfileImage } from "../funcs/authUserUpdateProfileImage.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
-import { NotificationPreferences } from "./notificationpreferences.js";
 
 export class CeStorefrontUser extends ClientSDK {
-  private _notificationPreferences?: NotificationPreferences;
-  get notificationPreferences(): NotificationPreferences {
-    return (this._notificationPreferences ??= new NotificationPreferences(
-      this._options,
+  /**
+   * Retrieve a user
+   *
+   * @remarks
+   * The Retrieve User API is designed to facilitate the retrieval of comprehensive user information from the system. A required parameter is a user-id of the user whose information needs to be retrieved.
+   */
+  async get(
+    request: operations.GetAuthUserIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetAuthUserIdResponseBody> {
+    return unwrapAsync(authUserGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a user
+   *
+   * @remarks
+   * The Update User API helps to efficiently modify and enhance user information within the system, ensuring that user profiles remain accurate and up-to-date. This API provides a secure and flexible mechanism for updating specific details while maintaining adherence to established conventions.
+   */
+  async update(
+    request: operations.PutAuthUserIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PutAuthUserIdResponseBody> {
+    return unwrapAsync(authUserUpdate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Add profile image
+   *
+   * @remarks
+   * The Profile Image API streamlines the process of uploading profile images associating with user accounts, offering a user-centric approach to visual identity customization. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution. Overall, the Profile Image API enhances user engagement by seamlessly integrating personalized visual elements into digital platforms.
+   */
+  async addProfileImage(
+    request: operations.PostAuthUserIdProfileImageRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthUserIdProfileImageResponseBody> {
+    return unwrapAsync(authUserAddProfileImage(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update profile image
+   *
+   * @remarks
+   * The Profile Image API streamlines the process of updating profile images associating with user accounts, offering a user-centric approach to visual identity customization. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution. Overall, the Profile Image API enhances user engagement by seamlessly integrating personalized visual elements into digital platforms.
+   */
+  async updateProfileImage(
+    request: operations.PutAuthUserIdProfileImageRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PutAuthUserIdProfileImageResponseBody> {
+    return unwrapAsync(authUserUpdateProfileImage(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete profile image
+   *
+   * @remarks
+   * Delete profile image API streamlines the process of removing profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.
+   */
+  async deleteProfileImage(
+    request: operations.DeleteAuthUserIdProfileImageRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteAuthUserIdProfileImageResponseBody> {
+    return unwrapAsync(authUserDeleteProfileImage(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a profile image
+   *
+   * @remarks
+   * Retrieve user profile image API streamlines the process of retriving profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.
+   */
+  async getProfileImage(
+    request: operations.GetAuthUserIdProfileImageRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetAuthUserIdProfileImageResponseBody> {
+    return unwrapAsync(authUserGetProfileImage(
+      this,
+      request,
+      options,
     ));
   }
 
@@ -23,11 +126,11 @@ export class CeStorefrontUser extends ClientSDK {
    * @remarks
    * The Deactivate Account API providing users with a straightforward method to deactivate their accounts. Upon successful deactivation, the API responds with a confirmation message. Error responses are detailed, aiding developers in addressing issues promptly.
    */
-  async deactivate(
+  async deactivateAccount(
     request: operations.PutAuthUserIdDeactivateRequest,
     options?: RequestOptions,
   ): Promise<operations.PutAuthUserIdDeactivateResponseBody> {
-    return unwrapAsync(authUserDeactivate(
+    return unwrapAsync(authUserDeactivateAccount(
       this,
       request,
       options,
@@ -50,4 +153,53 @@ export class CeStorefrontUser extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Forgot password
+   *
+   * @remarks
+   * The Forgot Password API provides a secure mechanism for users to initiate the password recovery process. This API provides one-time password (OTP) token, which facilitas the resetting of user’s account password.
+   */
+  async forgotPassword(
+    request: operations.PostAuthForgotPasswordRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthForgotPasswordResponseBody> {
+    return unwrapAsync(authUserForgotPassword(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Reset password
+   *
+   * @remarks
+   * Reset password
+   */
+  async resetPassword(
+    request: operations.PostAuthResetPasswordRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthResetPasswordResponseBody> {
+    return unwrapAsync(authUserResetPassword(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Logout user
+   *
+   * @remarks
+   * The Logout User API initiate the logout process for a user. Upon a successful request, the API responds with a confirmation message. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.
+   */
+  async logout(
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthLogoutResponseBody> {
+    return unwrapAsync(authUserLogout(
+      this,
+      options,
+    ));
+  }
 }