@commercengine/storefront-sdk 0.3.0 → 0.3.1

package/dist/lib/cart.d.ts

@@ -1,100 +1,53 @@
 import { StorefrontAPIClient } from "./client";
-import type { components } from "../types/storefront";
-import { ClientStorage } from "./auth";
+import { AddToWishlistBody, AddToWishlistContent, AddToWishlistPathParams, ApiResult, ApplyCouponBody, ApplyCouponContent, ApplyCouponPathParams, CreateCartAddressBody, CreateCartAddressContent, CreateCartAddressPathParams, CreateCartBody, DeleteCartPathParams, DeleteCartResponse, DeleteFromWishlistBody, DeleteFromWishlistContent, DeleteFromWishlistPathParams, DeleteUserCartPathParams, DeleteUserCartResponse, GetCartContent, GetCartPathParams, GetUserCartContent, GetUserCartPathParams, GetWishlistContent, GetWishlistPathParams, RedeemCreditBalanceBody, RedeemCreditBalanceContent, RedeemCreditBalancePathParams, RedeemGiftCardBody, RedeemGiftCardContent, RedeemGiftCardPathParams, RedeemLoyaltyPointsBody, RedeemLoyaltyPointsContent, RedeemLoyaltyPointsPathParams, RemoveCouponContent, RemoveCouponPathParams, RemoveCreditBalanceContent, RemoveCreditBalancePathParams, RemoveGiftCardContent, RemoveGiftCardPathParams, RemoveLoyaltyPointsContent, RemoveLoyaltyPointsPathParams, UpdateCartBody, UpdateCartContent, UpdateCartPathParams, UpdateShippingMethodBody, UpdateShippingMethodContent, UpdateShippingMethodPathParams } from "../types/storefront-api-types";
+import { CreateCartContent } from "../types/storefront-api-types";
 /**
  * Client for interacting with cart endpoints
  */
 export declare class CartClient extends StorefrontAPIClient {
-    private clientStorage;
-    /**
-     * Set the client storage implementation to use for cart ID management
-     *
-     * @param storage - The client storage instance
-     */
-    setClientStorage(storage: ClientStorage): void;
-    /**
-     * Get the stored cart ID
-     *
-     * @returns Promise that resolves to the cart ID or null if not found
-     */
-    getCartId(): Promise<string | null>;
-    /**
-     * Set the cart ID in storage
-     *
-     * @param cartId - The cart ID to store
-     */
-    setCartId(cartId: string): Promise<void>;
-    /**
-     * Clear the stored cart ID
-     */
-    clearCartId(): Promise<void>;
     /**
      * Create a new cart
      *
      * @param payload - Object containing the items to add to the cart
      * @returns Promise with the created cart
      */
-    createCart(payload: {
-        items: components["schemas"]["UpdateCartItem"][];
-    }): Promise<{
-        cart: components["schemas"]["Cart"];
-    }>;
+    createCart(payload: CreateCartBody): Promise<ApiResult<CreateCartContent>>;
     /**
      * Get cart details - either by ID or using the stored cart ID
      *
-     * @param cartId - Optional cart ID (if not provided, uses stored cart ID)
+     * @param cartId - The ID of the cart
      * @returns Promise with cart details
-     * @throws Error if no cartId is provided and none is stored
      */
-    getCart(cartId?: string): Promise<{
-        cart: components["schemas"]["Cart"];
-    }>;
+    getCart(cartId: GetCartPathParams): Promise<ApiResult<GetCartContent>>;
     /**
      * Delete a cart - either by ID or using the stored cart ID
      *
-     * @param cartId - Optional cart ID (if not provided, uses stored cart ID)
+     * @param cartId - The ID of the cart
      * @returns Promise that resolves when the cart is deleted
-     * @throws Error if no cartId is provided and none is stored
      */
-    deleteCart(cartId?: string): Promise<void>;
-    /**
-     * Add item to cart - either by specified ID or stored cart ID
-     * Will create a new cart if no cart ID is available
-     *
-     * @param item - The item to add to the cart
-     * @param cartId - Optional cart ID (if not provided, uses stored cart ID or creates a new cart)
-     * @returns Promise with updated or created cart
-     */
-    addItem(item: components["schemas"]["UpdateCartItem"], cartId?: string): Promise<{
-        cart: components["schemas"]["Cart"];
-    }>;
+    deleteCart(cartId: DeleteCartPathParams): Promise<ApiResult<DeleteCartResponse>>;
     /**
      * Update cart items (add, update quantity, remove)
      *
-     * @param cartId - The ID of the cart or undefined to use stored cart ID
-     * @param item - The item data
+     * @param cartId - The cart id
+     * @param body - The body of the request
      * @returns Promise with updated cart
-     * @throws Error if no cartId is provided and none is stored
      */
-    updateCartItem(cartId: string | undefined, item: components["schemas"]["UpdateCartItem"]): Promise<{
-        cart: components["schemas"]["Cart"];
-    }>;
+    addDeleteCartItem(cartId: UpdateCartPathParams, body: UpdateCartBody): Promise<ApiResult<UpdateCartContent>>;
     /**
      * Get cart details by user ID
      *
      * @param userId - The ID of the user
      * @returns Promise with cart details
      */
-    getUserCart(userId: string): Promise<{
-        cart: components["schemas"]["Cart"];
-    }>;
+    getUserCart(userId: GetUserCartPathParams): Promise<ApiResult<GetUserCartContent>>;
     /**
      * Delete a cart by user ID
      *
      * @param userId - The ID of the user
      * @returns Promise that resolves when the cart is deleted
      */
-    deleteUserCart(userId: string): Promise<void>;
+    deleteUserCart(userId: DeleteUserCartPathParams): Promise<ApiResult<DeleteUserCartResponse>>;
     /**
      * Update cart addresses
      *
@@ -102,15 +55,7 @@ export declare class CartClient extends StorefrontAPIClient {
      * @param addressData - The address data
      * @returns Promise with updated cart
      */
-    updateCartAddress(cartId: string, addressData: {
-        billing_address_id: string;
-        shipping_address_id: string;
-    } | {
-        billing_address: components["schemas"]["CustomerAddress"];
-        shipping_address: components["schemas"]["CustomerAddress"];
-    }): Promise<{
-        cart: components["schemas"]["Cart"];
-    }>;
+    updateCartAddress(cartId: CreateCartAddressPathParams, addressData: CreateCartAddressBody): Promise<ApiResult<CreateCartAddressContent>>;
     /**
      * Apply a coupon to the cart
      *
@@ -118,18 +63,14 @@ export declare class CartClient extends StorefrontAPIClient {
      * @param couponCode - The coupon code
      * @returns Promise with updated cart
      */
-    applyCoupon(cartId: string, couponCode: string): Promise<{
-        cart: components["schemas"]["Cart"];
-    }>;
+    applyCoupon(cartId: ApplyCouponPathParams, couponCode: ApplyCouponBody): Promise<ApiResult<ApplyCouponContent>>;
     /**
      * Remove a coupon from the cart
      *
      * @param cartId - The ID of the cart
      * @returns Promise with updated cart
      */
-    removeCoupon(cartId: string): Promise<{
-        cart: components["schemas"]["Cart"];
-    }>;
+    removeCoupon(cartId: RemoveCouponPathParams): Promise<ApiResult<RemoveCouponContent>>;
     /**
      * Redeem loyalty points
      *
@@ -137,16 +78,73 @@ export declare class CartClient extends StorefrontAPIClient {
      * @param points - The number of points to redeem
      * @returns Promise with updated cart
      */
-    redeemLoyaltyPoints(cartId: string, points: number): Promise<{
-        cart: components["schemas"]["Cart"];
-    }>;
+    redeemLoyaltyPoints(cartId: RedeemLoyaltyPointsPathParams, points: RedeemLoyaltyPointsBody): Promise<ApiResult<RedeemLoyaltyPointsContent>>;
     /**
      * Remove loyalty points
      *
      * @param cartId - The ID of the cart
      * @returns Promise with updated cart
      */
-    removeLoyaltyPoints(cartId: string): Promise<{
-        cart: components["schemas"]["Cart"];
-    }>;
+    removeLoyaltyPoints(cartId: RemoveLoyaltyPointsPathParams): Promise<ApiResult<RemoveLoyaltyPointsContent>>;
+    /**
+     * Update shipping method
+     *
+     * @param cartId - The ID of the cart
+     * @param body - The body of the request
+     * @returns Promise with updated cart
+     */
+    updateShippingMethod(cartId: UpdateShippingMethodPathParams, body: UpdateShippingMethodBody): Promise<ApiResult<UpdateShippingMethodContent>>;
+    /**
+     * Use credit balance
+     *
+     * @param cartId - The ID of the cart
+     * @param body - The body of the request
+     * @returns Promise with updated cart
+     */
+    redeemCreditBalance(cartId: RedeemCreditBalancePathParams, body: RedeemCreditBalanceBody): Promise<ApiResult<RedeemCreditBalanceContent>>;
+    /**
+     * Remove credit balance
+     *
+     * @param cartId - The ID of the cart
+     * @returns Promise with updated cart
+     */
+    removeCreditBalance(cartId: RemoveCreditBalancePathParams): Promise<ApiResult<RemoveCreditBalanceContent>>;
+    /**
+     * Redeem gift card
+     *
+     * @param cartId - The ID of the cart
+     * @param body - The body of the request
+     * @returns Promise with updated cart
+     */
+    redeemGiftCard(cartId: RedeemGiftCardPathParams, body: RedeemGiftCardBody): Promise<ApiResult<RedeemGiftCardContent>>;
+    /**
+     * Remove gift card
+     *
+     * @param cartId - The ID of the cart
+     * @returns Promise with updated cart
+     */
+    removeGiftCard(cartId: RemoveGiftCardPathParams): Promise<ApiResult<RemoveGiftCardContent>>;
+    /**
+     * Get wishlist items
+     *
+     * @param userId - The ID of the user
+     * @returns Promise with wishlist items
+     */
+    getWishlist(userId: GetWishlistPathParams): Promise<ApiResult<GetWishlistContent>>;
+    /**
+     * Add item to wishlist
+     *
+     * @param userId - The ID of the user
+     * @param itemId - The ID of the item
+     * @returns Promise with updated wishlist
+     */
+    addToWishlist(userId: AddToWishlistPathParams, itemId: AddToWishlistBody): Promise<ApiResult<AddToWishlistContent>>;
+    /**
+     * Remove item from wishlist
+     *
+     * @param userId - The ID of the user
+     * @param itemId - The ID of the item
+     * @returns Promise with updated wishlist
+     */
+    removeFromWishlist(userId: DeleteFromWishlistPathParams, body: DeleteFromWishlistBody): Promise<ApiResult<DeleteFromWishlistContent>>;
 }