@liquidcommerce/cloud-sdk 1.2.0 → 1.4.0

package/dist/types/interfaces/user.interface.d.ts

@@ -1,53 +1,189 @@
 import type { ENUM_ADDRESS_TYPE } from '../enums';
 import type { ICoreParams } from '../types';
+/**
+ * Represents a user session with key and secret used for authentication.
+ */
 export interface IUserSession {
     key: string | null;
     secret: string | null;
     createdAt: Date;
 }
-export interface IUserAddress {
-    id: string;
+/**
+ * Represents the basic structure of a user's address.
+ *
+ * @interface IUserAddressBase
+ *
+ * @property {string} placesId - The unique identifier for the place.
+ * @property {string} one - The primary street address or neighborhood.
+ * @property {string} two - The secondary address information, such as apartment or suite number.
+ * @property {string} city - The name of the city.
+ * @property {string} state - The name of the state or region.
+ * @property {string} zip - The postal code.
+ * @property {string} country - The name of the country.
+ * @property {number} lat - The latitude coordinate of the address.
+ * @property {number} long - The longitude coordinate of the address.
+ */
+export interface IUserAddressBase {
+    placesId: string;
     one: string;
-    two?: string | null;
+    two: string;
     city: string;
     state: string;
     zip: string;
     country: string;
+    lat: number;
+    long: number;
+}
+/**
+ * IUserAddress interface represents a user's address details.
+ * It extends the IUserAddressBase interface, adding additional properties for
+ * unique identification, timestamps, and default status.
+ *
+ * @interface IUserAddress
+ * @extends {IUserAddressBase}
+ *
+ * @property {string} id - Unique identifier for the user's address.
+ * @property {Date} createdAt - Timestamp indicating when the address was created.
+ * @property {Date} updatedAt - Timestamp indicating the last update to the address.
+ * @property {boolean} [isDefault] - Optional flag indicating if this is the default address.
+ */
+export interface IUserAddress extends IUserAddressBase {
+    id: string;
     createdAt: Date;
     updatedAt: Date;
     isDefault?: boolean;
 }
+/**
+ * Interface representing a saved card.
+ *
+ * @interface ISavedCard
+ */
+export interface ISavedCard {
+    brand: string | null;
+    country: string | null;
+    expMonth: number | null;
+    expYear: number | null;
+    last4: string | null;
+    funding: string | null;
+}
+/**
+ * Represents a user's payment method.
+ *
+ * @interface IUserPayment
+ * @property {string} id - The unique identifier for the payment method.
+ * @property {string} type - The type of the payment method (e.g., credit card, PayPal).
+ * @property {boolean} isDefault - Indicates whether this payment method is the default one.
+ * @property {ISavedCard} [card] - The saved card details if the payment method is a card.
+ * @property {Date} createdAt - The date when the payment method was added.
+ */
+export interface IUserPayment {
+    id: string;
+    type: string;
+    isDefault: boolean;
+    card?: ISavedCard;
+    createdAt: Date;
+}
+/**
+ * The IUser interface defines the structure for user objects within the application.
+ */
 export interface IUser {
     id: string;
     email: string;
     firstName: string | null;
     lastName: string | null;
     phone: string | null;
+    company: string | null;
+    profileImage: string | null;
     birthDate: string | null;
     createdAt: Date;
     updatedAt: Date;
     addresses: IUserAddress[];
+    savedPayments: IUserPayment[];
     session: IUserSession;
 }
+/**
+ * Represents a basic user excluding the session information.
+ *
+ * This type is useful when user session details are not required
+ * or need to be omitted for certain operations, such as basic
+ * user management tasks.
+ *
+ * It extends the IUser interface but removes the 'session' property.
+ *
+ * Typically used in contexts where minimal user information is
+ * sufficient, focusing on non-session related attributes.
+ */
+export type BaseUser = Omit<IUser, 'session'>;
+/**
+ * Interface representing the parameters for a user session.
+ */
 export interface IUserSessionParams extends ICoreParams {
     id?: string;
     email?: string;
     firstName?: string | null;
     lastName?: string | null;
     phone?: string | null;
+    company?: string | null;
+    profileImage?: string | null;
     birthDate?: string | null;
 }
+/**
+ * Interface representing the response from a purge operation.
+ */
 export interface IPurgeResponse {
     deleted: boolean;
     message: string;
 }
+/**
+ * Interface representing the parameters required for user address operations.
+ * Extends the core parameters from ICoreParams.
+ */
 export interface IUserAddressParams extends ICoreParams {
     customerId: string;
-    one: string;
-    two?: string | null;
-    city: string;
-    state: string;
-    zip: string;
-    isDefault?: boolean;
+    placesId?: string;
+    one?: string;
+    two?: string;
+    city?: string;
+    state?: string;
+    zip?: string;
+    country?: string;
+    lat?: number;
+    long?: number;
     type: ENUM_ADDRESS_TYPE;
+    isDefault?: boolean;
+}
+/**
+ * Interface representing the parameters required for user payment operations.
+ *
+ * This interface extends the core parameters interface (`ICoreParams`) and includes
+ * specific properties necessary for processing a user payment.
+ *
+ * Properties:
+ * - `customerId`: A string representing the unique identifier of the customer making the payment.
+ * - `paymentMethodId`: A string representing the unique identifier of the payment method to be used.
+ */
+export interface IUserPaymentParams extends ICoreParams {
+    customerId: string;
+    paymentMethodId: string;
+}
+/**
+ * Interface representing the parameters required to add a user payment.
+ *
+ * Extends the IUserPaymentParams interface to inherit the basic payment parameters.
+ *
+ * @property isDefault - Optional boolean indicating if the payment method should be set as default.
+ */
+export interface IUserPaymentAddParams extends IUserPaymentParams {
+    isDefault?: boolean;
+}
+/**
+ * IUserPaymentUpdateParams is an interface extending IUserPaymentParams,
+ * representing the parameters required to update user payment information.
+ *
+ * @extends IUserPaymentParams
+ *
+ * @property {boolean} isDefault - Indicates whether the payment method is the default one.
+ */
+export interface IUserPaymentUpdateParams extends IUserPaymentParams {
+    isDefault: boolean;
 }

package/dist/types/liquid-commerce-client.d.ts

@@ -1,173 +1,5 @@
-import { LIQUID_COMMERCE_ENV } from './enums';
-import type { ICart, ICartUpdateParams } from './interfaces/cart.interface';
-import type { ICatalog, ICatalogParams } from './interfaces/catalog.service.interface';
-import type { ICheckoutCompleteParams, ICheckoutCompleteResponse, ICheckoutPrepareParams, ICheckoutPrepareResponse } from './interfaces/checkout.interface';
-import type { IAddressMethod, ICartMethod, ICatalogMethod, ICheckoutMethod, ILiquidCommerceClient, IPaymentMethod, IUserMethod } from './interfaces/liquid-commerce-client.interface';
-import type { ILiquidPaymentConfig, ILiquidPaymentToken, IPaymentElementEventMap } from './interfaces/payment.interface';
-import type { IPurgeResponse, IUser, IUserAddress, IUserAddressParams, IUserSessionParams } from './interfaces/user.interface';
-import type { IAddressAutocompleteParams, IAddressAutocompleteResult, IAddressDetailsParams, IAddressDetailsResult } from './services/address.service';
-import type { IAvailabilityParams, IAvailabilityResponse } from './services/catalog.service';
-import type { IApiResponseWithData, IApiResponseWithoutData, ILiquidCommerceConfig } from './types';
-/**
- * The LiquidCommerceClient class is a client for interacting with the LiquidCommerce Cloud APIs.
- * This client encapsulates the logic for working with various services, including addresses, catalog products,
- * carts, users, payments, checkouts, and orders.
- *
- * The client handles authentication, service initialization, and ensures secure interaction with the
- * LiquidCommerce Cloud API by managing token expiration and re-authentication automatically.
- *
- * @class
- * @implements {ILiquidCommerceClient}
- */
-declare class LiquidCommerceClient implements ILiquidCommerceClient {
-    private readonly authenticatedClient;
-    private addressService;
-    private catalogService;
-    private cartService;
-    private userService;
-    private paymentService;
-    private checkoutService;
-    private config;
-    private singletonManager;
-    /**
-     * Creates an instance of LiquidCommerceClient.
-     *
-     * @constructor
-     * @param {string} apiKey - The API key used for authenticating with the LiquidCommerce Cloud API.
-     * @param {ILiquidCommerceConfig} config - Configuration options including environment settings, base URLs, and other preferences.
-     */
-    constructor(apiKey: string, config: ILiquidCommerceConfig);
-    /**
-     * Determines the appropriate base URL for the API based on the environment.
-     *
-     * @private
-     * @param {ILiquidCommerceConfig} config - Configuration options.
-     * @return {string} - The base URL for the selected environment.
-     */
-    private determineBaseURL;
-    /**
-     * Initializes the client by authenticating with the LiquidCommerce API.
-     * This method should be called before making any API requests.
-     *
-     * @public
-     * @return {Promise<void>} - Resolves when initialization is successful.
-     * @throws {Error} - Throws an error if authentication fails.
-     */
-    init(): Promise<void>;
-    /**
-     * Ensures that the client is authenticated before making API requests.
-     * If the authentication token is expired, it will attempt to re-authenticate.
-     *
-     * @private
-     * @return {Promise<void>} - Resolves when the client is authenticated.
-     * @throws {Error} - Throws an error if re-authentication fails.
-     */
-    private ensureAuthenticated;
-    /**
-     * Address object that provides methods for performing address autocompletion and retrieving address details.
-     *
-     * @interface IAddressMethod address
-     *
-     * @property {function(Omit<IAddressAutocompleteParams, 'key'>): Promise<IApiResponseWithData<IAddressAutocompleteResult[]>>} autocomplete -
-     *    Method for performing address autocompletion based on the provided parameters.
-     *
-     * @property {function(Omit<IAddressDetailsParams, 'key'>): Promise<IApiResponseWithData<IAddressDetailsResult>>} details -
-     *    Method for retrieving address details based on the provided parameters.
-     */
-    address: IAddressMethod;
-    /**
-     * Catalog object that provides methods for availability and search operations.
-     *
-     * @interface ICatalogMethod catalog
-     *
-     * @property {function(params: IAvailabilityParams): Promise<IApiResponseWithoutData<IAvailabilityResponse>>} availability -
-     *    Method to check the availability of a specific item in the catalog.
-     *
-     * @property {function(params: ICatalogParams): Promise<IApiResponseWithoutData<ICatalog>>} search -
-     *    Method to perform a search in the catalog based on the provided parameters.
-     *
-     * @see {@link IApiResponseWithoutData} for the structure of the promise returned by both methods.
-     */
-    catalog: ICatalogMethod;
-    /**
-     * Represents a cart object with methods for updating and retrieving cart data.
-     *
-     * @interface ICartMethod cart
-     *
-     * @property {function(id: string): Promise<IApiResponseWithoutData<ICart>>} get -
-     *    Retrieves the cart by its ID, or returns a new cart if no ID is provided.
-     * @property {function(params: ICartUpdateParams): Promise<IApiResponseWithoutData<ICart>>} update -
-     *    Method to update the cart with the provided parameters.
-     *
-     * @see {@link ICartUpdateParams} for the structure of the parameters required to update the cart.
-     * @see {@link IApiResponseWithoutData} for the structure of the promise returned by both methods.
-     * @see {@link ICart} for the structure of the cart data returned.
-     */
-    cart: ICartMethod;
-    /**
-     * User object that provides methods for user-related operations.
-     *
-     * @interface IUserMethod user
-     *
-     * @property {function(params: IUserSessionParams): Promise<IApiResponseWithData<IUser>>} session -
-     *    Method for creating or updating a user session.
-     * @property {function(identifier: string): Promise<IApiResponseWithData<IPurgeResponse>>} purge -
-     *    Method for purging a user's data from the system.
-     * @property {function(params: IUserAddressParams): Promise<IApiResponseWithData<IUserAddress>>} updateAddress -
-     *    Method for updating or creating a user's address.
-     * @property {function(addressId: string): Promise<IApiResponseWithData<IPurgeResponse>>} purgeAddress -
-     *    Method for purging a user's address.
-     *
-     * @see {@link IUserSessionParams} for the structure of the session request parameters.
-     * @see {@link IUserAddressParams} for the structure of the address update request parameters.
-     * @see {@link IUser} for the structure of the user data returned.
-     * @see {@link IUserAddress} for the structure of the user's address data returned.
-     * @see {@link IPurgeResponse} for the structure of the user data returned.
-     *
-     * */
-    user: IUserMethod;
-    /**
-     * Payment object that provides methods for payment-related operations.
-     *
-     * @interface IPaymentMethod payment
-     *
-     * @property {function(config: ILiquidPaymentConfig): Promise<void>} mount -
-     *    Method for mounting the payment element into the DOM.
-     *
-     * @property {function(): Promise<ILiquidPaymentToken>} generateToken -
-     *    Method for generating a payment token for the current payment information.
-     *
-     * @property {function(eventType: K, handler: function): void} subscribe -
-     *    Method for subscribing to payment element events.
-     *
-     * @property {function(eventType: K, handler?: function): void} unsubscribe -
-     *    Method for unsubscribing from payment element events.
-     *
-     * @see {@link ILiquidPaymentConfig} Represents the configuration for Liquid payment.
-     * @see {@link ILiquidPaymentToken} Represents a payment token for liquid payments.
-     * @see {@link ILiquidPaymentError} Represents an error that occurs during a liquid payment.
-     * @see {@link ILiquidPaymentElementOptions} The options for the payment element.
-     * @see {@link IPaymentElementEventMap} The map of payment element event types to their corresponding event objects.
-     */
-    payment: IPaymentMethod;
-    /**
-     * Checkout object that provides methods for checkout-related operations.
-     *
-     * @interface ICheckoutMethod checkout
-     *
-     * @property {function(params: ICheckoutPrepareParams): Promise<IApiResponseWithoutData<ICheckoutPrepareResponse>>} prepare -
-     *    Method to prepare a checkout based on the provided parameters.
-     * @property {function(params: ICheckoutCompleteParams): Promise<IApiResponseWithoutData<ICheckoutCompleteResponse>>} complete -
-     *   Method completes a checkout process with the provided token and payment information.
-     *
-     * @see {@link ICheckoutPrepareParams} for the structure of the prepare request parameters.
-     * @see {@link IApiResponseWithoutData} for the structure of the promise returned by the prepare method.
-     * @see {@link ICheckoutPrepareResponse} for the structure of the prepared checkout data returned.
-     * @see {@link ICheckoutCompleteParams} for the structure of the complete request parameters.
-     * @see {@link ICheckoutCompleteResponse} for the structure of the complete checkout data returned.
-     */
-    checkout: ICheckoutMethod;
-}
+import type { ILiquidCommerceClient } from './interfaces';
+import type { ILiquidCommerceConfig } from './types';
 /**
  * Factory function to create and initialize a LiquidCommerceClient instance.
  *
@@ -184,6 +16,4 @@ declare class LiquidCommerceClient implements ILiquidCommerceClient {
  *
  * @throws {Error} - Throws an error if the client initialization fails.
  */
-export declare function LiquidCommerce(apiKey: string, config: ILiquidCommerceConfig): Promise<LiquidCommerceClient>;
-export { LIQUID_COMMERCE_ENV };
-export type { IAddressAutocompleteParams, IAddressAutocompleteResult, IAddressDetailsParams, IAddressDetailsResult, IAddressMethod, IApiResponseWithData, IApiResponseWithoutData, IAvailabilityParams, IAvailabilityResponse, ICart, ICartMethod, ICartUpdateParams, ICatalog, ICatalogMethod, ICatalogParams, ICheckoutCompleteParams, ICheckoutCompleteResponse, ICheckoutMethod, ICheckoutPrepareParams, ICheckoutPrepareResponse, ILiquidCommerceClient, ILiquidCommerceConfig, ILiquidPaymentConfig, ILiquidPaymentToken, IPaymentElementEventMap, IPaymentMethod, IPurgeResponse, IUser, IUserAddress, IUserAddressParams, IUserMethod, IUserSessionParams, };
+export declare function LiquidCommerce(apiKey: string, config: ILiquidCommerceConfig): Promise<ILiquidCommerceClient>;

package/dist/types/services/address.service.d.ts

@@ -1,21 +1,6 @@
 import type { AuthenticatedService } from '../core';
-import type { ICoords } from '../interfaces/address.interface';
-import type { IApiResponseWithData, ICoreParams } from '../types';
-export interface IAddressAutocompleteParams extends ICoreParams {
-    input: string;
-}
-export interface IAddressAutocompleteResult {
-    id: string;
-    description: string;
-}
-export interface IAddressDetailsParams extends ICoreParams {
-    id: string;
-}
-export interface IAddressDetailsResult {
-    formattedAddress: string;
-    coords: ICoords;
-}
-type AddressServiceResponse<T> = IApiResponseWithData<T>;
+import type { IAddressAutocompleteParams, IAddressAutocompleteResult, IAddressDetailsParams, IAddressDetailsResult } from '../interfaces';
+import type { AddressServiceResponse } from '../types';
 /**
  * Represents a service for interacting with address-related functionality.
  */
@@ -41,4 +26,3 @@ export declare class AddressService {
      */
     details(params: IAddressDetailsParams, googlePlacesApiKey: string): Promise<AddressServiceResponse<IAddressDetailsResult>>;
 }
-export {};

package/dist/types/services/cart.service.d.ts

@@ -1,5 +1,5 @@
 import type { AuthenticatedService, CartHelperService } from '../core';
-import type { ICart, ICartUpdateParams } from '../interfaces/cart.interface';
+import type { ICart, ICartUpdateParams } from '../interfaces';
 import type { IApiResponseWithoutData } from '../types';
 /**
  * The CartService class is responsible for fetching and updating cart data from the server.

package/dist/types/services/catalog.service.d.ts

@@ -1,17 +1,6 @@
 import type { AuthenticatedService, CatalogHelperService } from '../core';
-import type { ILocBase } from '../interfaces/address.interface';
-import type { IProduct } from '../interfaces/catalog.interface';
-import type { ICatalog, ICatalogParams } from '../interfaces/catalog.service.interface';
-import type { IRetailer } from '../interfaces/retailer.interface';
+import type { IAvailabilityParams, IAvailabilityResponse, ICatalog, ICatalogParams } from '../interfaces';
 import type { IApiResponseWithoutData } from '../types';
-export interface IAvailabilityParams extends ILocBase {
-    upcs: string[];
-    shouldShowOffHours?: boolean;
-}
-export interface IAvailabilityResponse {
-    products: IProduct[];
-    retailers: IRetailer[];
-}
 /**
  * The CatalogService class provides methods for interacting with the catalog API.
  */

package/dist/types/services/checkout.service.d.ts

@@ -1,5 +1,5 @@
 import type { AuthenticatedService, CheckoutHelperService } from '../core';
-import type { ICheckoutCompleteParams, ICheckoutCompleteResponse, ICheckoutPrepareParams, ICheckoutPrepareResponse } from '../interfaces/checkout.interface';
+import type { ICheckoutCompleteParams, ICheckoutCompleteResponse, ICheckoutPrepareParams, ICheckoutPrepareResponse } from '../interfaces';
 import type { IApiResponseWithoutData } from '../types';
 /**
  * A service for managing the checkout process.

package/dist/types/services/index.d.ts

@@ -0,0 +1,5 @@
+export * from './address.service';
+export * from './catalog.service';
+export * from './checkout.service';
+export * from './payment.service';
+export * from './user.service';

package/dist/types/services/payment.service.d.ts

@@ -1,5 +1,5 @@
 import type { PaymentProviderService } from '../core';
-import type { ILiquidPaymentConfig, ILiquidPaymentError, ILiquidPaymentToken, IPaymentElementEventMap } from '../interfaces/payment.interface';
+import type { ILiquidPaymentConfig, ILiquidPaymentError, ILiquidPaymentToken, IPaymentElementEventMap } from '../interfaces';
 /**
  * The PaymentService class provides methods for interacting with payment functionality.
  */
@@ -36,4 +36,27 @@ export declare class PaymentService {
      * @return void
      */
     unsubscribe<K extends keyof IPaymentElementEventMap>(eventType: K, handler?: (event: IPaymentElementEventMap[K]) => void): void;
+    /**
+     * Collapses the payment element if it has been initialized.
+     * Throws an error if the payment element has not been initialized.
+     *
+     * @return {void}
+     * @throws {Error} Will throw an error if the payment element has not been initialized.
+     */
+    collapse: () => void;
+    /**
+     * Unmounts the payment element from the DOM.
+     * Throws an error if the payment element has not been initialized.
+     *
+     * @return {void}
+     * @throws {Error} Will throw an error if the payment element has not been initialized.
+     */
+    unmount: () => void;
+    /**
+     * Destroys the payment element if it has been initialized.
+     *
+     * @return {void} No return value.
+     * @throws {Error} Will throw an error if the payment element has not been initialized.
+     */
+    destroy: () => void;
 }

package/dist/types/services/user.service.d.ts

@@ -1,5 +1,5 @@
 import type { AuthenticatedService } from '../core';
-import type { IPurgeResponse, IUser, IUserAddress, IUserAddressParams, IUserSessionParams } from '../interfaces/user.interface';
+import type { BaseUser, IPurgeResponse, IUser, IUserAddress, IUserAddressParams, IUserPayment, IUserPaymentAddParams, IUserPaymentUpdateParams, IUserSessionParams } from '../interfaces';
 import type { IApiResponseWithData } from '../types';
 /**
  * A class representing a user service.
@@ -16,6 +16,14 @@ export declare class UserService {
      * @throws {Error} If the session creation/update request fails or if neither id nor email is provided.
      */
     createOrUpdateSession(params: IUserSessionParams): Promise<IApiResponseWithData<IUser>>;
+    /**
+     * Fetches user data from the API using the provided identifier.
+     *
+     * @param {string} identifier - The unique identifier for the user.
+     * @return {Promise<IApiResponseWithData<BaseUser>>} The API response containing
+     *  user data omitting the session field.
+     */
+    fetchUser(identifier: string): Promise<IApiResponseWithData<BaseUser>>;
     /**
      * Purges a user's data from the system.
      *
@@ -24,6 +32,14 @@ export declare class UserService {
      * @throws {Error} If the purge request fails or if the identifier is not provided.
      */
     purge(identifier: string): Promise<IApiResponseWithData<IPurgeResponse>>;
+    /**
+     * Adds a new address for a user.
+     *
+     * @param {IUserAddressParams} params - The parameters containing the user's address details.
+     * @return {Promise<IApiResponseWithData<IUserAddress>>} - A promise that resolves with the API response containing the added user address.
+     * @throws {Error} If the addAddress request fails or if the required parameters are not provided.
+     */
+    addAddress(params: IUserAddressParams): Promise<IApiResponseWithData<IUserAddress>>;
     /**
      * Updates or creates a new address for a user.
      *
@@ -32,6 +48,43 @@ export declare class UserService {
      * @throws {Error} If the address update request fails or if required parameters are missing.
      */
     updateAddress(params: IUserAddressParams): Promise<IApiResponseWithData<IUserAddress>>;
+    /**
+     * Validates the parameters required for updating a user address.
+     *
+     * @param {IUserAddressParams} params - The parameters to be validated for the address update. This should include
+     * at least the user ID and one of the following: address object, latitude and longitude, or a Google places ID.
+     * @return {IUserAddressParams} Throws an error if the required parameters are not provided.
+     */
+    private validateAddressParams;
+    /**
+     * Checks if the given user address parameters contain valid customer ID and user ID.
+     *
+     * @param {IUserAddressParams} params - The user address parameters object containing customerId and userId.
+     * @return {boolean} - Returns true if the customerId or userId is missing or not a string, otherwise returns false.
+     */
+    private hasUser;
+    /**
+     * Checks if the given user address object has a valid address.
+     *
+     * @param {IUserAddressParams} params - The user address parameters object containing address details.
+     *
+     * @return {boolean} Returns true if the user address object is valid; otherwise, returns false.
+     */
+    private hasUserAddressObj;
+    /**
+     * Checks if the user address coordinates (latitude and longitude) are not present or not of type 'number'.
+     *
+     * @param {IUserAddressParams} params - The user address parameters containing latitude and longitude.
+     * @return {boolean} Returns true if latitude or longitude are not provided or are not numbers, otherwise returns false.
+     */
+    private hasUserAddressCoords;
+    /**
+     * Checks whether the user address parameters contain a valid placesId.
+     *
+     * @param {IUserAddressParams} params - The user address parameters containing placesId.
+     * @return {boolean} Returns true if placesId is missing or not a string, false otherwise.
+     */
+    private hasUserAddressPlacesId;
     /**
      * Purges an address for a user.
      *
@@ -40,4 +93,33 @@ export declare class UserService {
      * @throws {Error} If the address purge request fails or if the address ID is not provided.
      */
     purgeAddress(addressId: string): Promise<IApiResponseWithData<IPurgeResponse>>;
+    /**
+     * Adds a new payment method for a user.
+     *
+     * @param {IUserPaymentParams} params - The parameters required to add a payment method.
+     * @param {string} params.customerId - The ID of the customer.
+     * @param {string} params.paymentMethodId - The ID of the payment method.
+     * @param {boolean} params.isDefault - Indicates whether the new payment method should be marked as default.
+     * @return {Promise<IApiResponseWithData<IUserPayment>>} - A promise that resolves to the response containing user payment information.
+     * @throws {Error} - Throws an error if required parameters are missing or if the request fails.
+     */
+    addPayment(params: IUserPaymentAddParams): Promise<IApiResponseWithData<IUserPayment>>;
+    /**
+     * Updates whether the default payment method for a user.
+     *
+     * @param {IUserPaymentParams} params - The payment parameters required to update payment. Must include `customerId`,
+     *  `paymentMethodId`, and a boolean `isDefault`.
+     * @returns {Promise<IApiResponseWithData<IUserPayment>>} - A promise that resolves to the API response containing
+     *  the updated payment information.
+     * @throws {Error} - Throws an error if required parameters are missing or the request fails.
+     */
+    updatePayment(params: IUserPaymentUpdateParams): Promise<IApiResponseWithData<IUserPayment>>;
+    /**
+     * Purges a payment record for a specified customer.
+     *
+     * @param {string} customerId - The ID of the customer whose payment record is to be purged.
+     * @param {string} paymentId - The ID of the payment record to be purged.
+     * @return {Promise<IApiResponseWithData<IPurgeResponse>>} A promise that resolves to the response of the purge request.
+     */
+    purgePayment(customerId: string, paymentId: string): Promise<IApiResponseWithData<IPurgeResponse>>;
 }

package/dist/types/types.d.ts

@@ -1,9 +1,16 @@
-import type { ENUM_BEER, ENUM_FOOD, ENUM_MERCHANDISE, ENUM_NON_ALCOHOLIC, ENUM_READY_TO_DRINK, ENUM_SPIRITS, ENUM_WINE, LIQUID_COMMERCE_ENV } from './enums';
+import type { ENUM_BEER, ENUM_FOOD, ENUM_MERCHANDISE, ENUM_MISCELLANEOUS, ENUM_NON_ALCOHOLIC, ENUM_READY_TO_DRINK, ENUM_SPIRITS, ENUM_WINE, LIQUID_COMMERCE_ENV } from './enums';
 export interface ICoreParams {
     refresh?: boolean;
+    isLean?: boolean;
+    isLegacy?: boolean;
+}
+export interface IAuth {
+    token: string;
+    exp: number;
+    type: 'ACCESS_TOKEN';
 }
 export interface IAuthResponse {
-    auth?: IAuthResponse;
+    auth?: IAuth;
 }
 export interface IResponseMetadata {
     languages: string[];
@@ -24,8 +31,6 @@ export type IApiResponseWithData<T> = IApiResponseBase & {
 export type IApiResponseWithoutData<T> = IApiResponseBase & {
     [K in keyof T]: T[K];
 };
-export type IApiResponse<T> = IApiResponseWithData<T> | IApiResponseWithoutData<T>;
-export declare function isApiResponseWithData<T>(response: IApiResponse<T>): response is IApiResponseWithData<T>;
 export interface ILiquidCommerceConfig {
     googlePlacesApiKey: string;
     env: LIQUID_COMMERCE_ENV;
@@ -33,4 +38,5 @@ export interface ILiquidCommerceConfig {
         stage?: string;
     };
 }
-export type LiquidTaxonomy = ENUM_BEER | ENUM_FOOD | ENUM_MERCHANDISE | ENUM_NON_ALCOHOLIC | ENUM_READY_TO_DRINK | ENUM_SPIRITS | ENUM_WINE;
+export type LiquidTaxonomy = ENUM_BEER | ENUM_FOOD | ENUM_MERCHANDISE | ENUM_MISCELLANEOUS | ENUM_NON_ALCOHOLIC | ENUM_READY_TO_DRINK | ENUM_SPIRITS | ENUM_WINE;
+export type AddressServiceResponse<T> = IApiResponseWithData<T>;