ce-storefront 0.0.1 → 0.0.4

package/src/sdk/cestorefrontuser.ts

@@ -0,0 +1,160 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { authUserAddProfileImage } from "../funcs/authUserAddProfileImage.js";
+import { authUserChangePassword } from "../funcs/authUserChangePassword.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";
+
+export class CeStorefrontUser extends ClientSDK {
+    /**
+     * 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));
+    }
+
+    /**
+     * Deactivate account
+     *
+     * @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 deactivateAccount(
+        request: operations.PutAuthUserIdDeactivateRequest,
+        options?: RequestOptions
+    ): Promise<operations.PutAuthUserIdDeactivateResponseBody> {
+        return unwrapAsync(authUserDeactivateAccount(this, request, options));
+    }
+
+    /**
+     * Change password
+     *
+     * @remarks
+     * The Change Password API is a key feature designed to provide a secure and standardized method for users to update their passwords.
+     */
+    async changePassword(
+        request?: operations.PostAuthChangePasswordRequestBody | undefined,
+        options?: RequestOptions
+    ): Promise<operations.PostAuthChangePasswordResponseBody> {
+        return unwrapAsync(authUserChangePassword(this, request, 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 | undefined,
+        options?: RequestOptions
+    ): Promise<operations.PostAuthForgotPasswordResponseBody> {
+        return unwrapAsync(authUserForgotPassword(this, request, options));
+    }
+
+    /**
+     * Reset password
+     *
+     * @remarks
+     * Reset password
+     */
+    async resetPassword(
+        request?: operations.PostAuthResetPasswordRequestBody | undefined,
+        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));
+    }
+}

package/src/sdk/coupons.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { offersCouponsList } from "../funcs/offersCouponsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Coupons extends ClientSDK {
+    /**
+     * Retrieve all coupons
+     *
+     * @remarks
+     * Retrieve active coupons
+     */
+    async list(options?: RequestOptions): Promise<operations.GetCouponsResponseBody> {
+        return unwrapAsync(offersCouponsList(this, options));
+    }
+}

package/src/sdk/customers.ts

@@ -2,10 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { customersGetAddresses } from "../funcs/customersGetAddresses.js";
-import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as operations from "../models/operations/index.js";
-import { unwrapAsync } from "../types/fp.js";
+import { ClientSDK } from "../lib/sdks.js";
 import { Addresses } from "./addresses.js";
 import { Loyalty } from "./loyalty.js";
 import { Reviews } from "./reviews.js";
@@ -25,17 +22,4 @@ export class Customers extends ClientSDK {
     get reviews(): Reviews {
         return (this._reviews ??= new Reviews(this.options$));
     }
-
-    /**
-     * Retrieve all addresses
-     *
-     * @remarks
-     * Retrieve billing and shipping address of particular customer
-     */
-    async getAddresses(
-        request: operations.GetAddressRequest,
-        options?: RequestOptions
-    ): Promise<operations.GetAddressResponseBody> {
-        return unwrapAsync(customersGetAddresses(this, request, options));
-    }
 }

package/src/sdk/{recommended.ts → customersapi.ts}

@@ -2,19 +2,22 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { catalogProductsRecommendedList } from "../funcs/catalogProductsRecommendedList.js";
+import { customersAPIGetRecommendedProducts } from "../funcs/customersAPIGetRecommendedProducts.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
-export class Recommended extends ClientSDK {
+export class CustomersAPI extends ClientSDK {
     /**
-     * Retrieve recommended products
+     * List all recommended products
      *
      * @remarks
      * Retrieves a list of recommended products for a specified user based on their browsing history, past purchases, and indicated preferences. The recommended products are returned sorted by relevance, providing a personalized shopping experience for each user.
      */
-    async list(options?: RequestOptions): Promise<operations.GetRecommendedResponseBody> {
-        return unwrapAsync(catalogProductsRecommendedList(this, options));
+    async getRecommendedProducts(
+        request: operations.GetRecommendedProductsRequest,
+        options?: RequestOptions
+    ): Promise<operations.GetRecommendedProductsResponseBody> {
+        return unwrapAsync(customersAPIGetRecommendedProducts(this, request, options));
     }
 }

package/src/sdk/newsletter.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { campaignsNewsletterSubscribe } from "../funcs/campaignsNewsletterSubscribe.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Newsletter extends ClientSDK {
+    /**
+     * Subscribe to newsletter
+     *
+     * @remarks
+     * Subscribe to newsletter
+     */
+    async subscribe(
+        request?: operations.PostCustomersNewsletterSubscriptionRequestBody | undefined,
+        options?: RequestOptions
+    ): Promise<operations.PostCustomersNewsletterSubscriptionResponseBody> {
+        return unwrapAsync(campaignsNewsletterSubscribe(this, request, options));
+    }
+}

package/src/sdk/notificationpreferences.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { userNotificationPreferencesCreate } from "../funcs/userNotificationPreferencesCreate.js";
+import { userNotificationPreferencesGet } from "../funcs/userNotificationPreferencesGet.js";
+import { userNotificationPreferencesUpdate } from "../funcs/userNotificationPreferencesUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class NotificationPreferences extends ClientSDK {
+    /**
+     * Retrieve user notification preferences
+     *
+     * @remarks
+     * The Retrieve Notification Preferences API allows clients to fetch a user's notification preferences based on their unique user identifier (user_id).
+     */
+    async get(
+        request: operations.GetAuthUserIdNotificationPreferencesRequest,
+        options?: RequestOptions
+    ): Promise<operations.GetAuthUserIdNotificationPreferencesResponseBody> {
+        return unwrapAsync(userNotificationPreferencesGet(this, request, options));
+    }
+
+    /**
+     * Create user notification preferences
+     *
+     * @remarks
+     * Create user notification preferences API allows clients to create a user's notification preferences based on their unique user identifier (user_id).
+     */
+    async create(
+        request: operations.PostAuthUserIdNotificationPreferencesRequest,
+        options?: RequestOptions
+    ): Promise<operations.PostAuthUserIdNotificationPreferencesResponseBody> {
+        return unwrapAsync(userNotificationPreferencesCreate(this, request, options));
+    }
+
+    /**
+     * Update user notification preferences
+     *
+     * @remarks
+     * Update Notification Preferences API allows clients to update a user's notification preferences based on their unique user identifier (user_id).
+     */
+    async update(
+        request: operations.PutAuthUserIdNotificationPreferencesRequest,
+        options?: RequestOptions
+    ): Promise<operations.PutAuthUserIdNotificationPreferencesResponseBody> {
+        return unwrapAsync(userNotificationPreferencesUpdate(this, request, options));
+    }
+}

package/src/sdk/offers.ts

@@ -2,30 +2,18 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { offersGetCoupons } from "../funcs/offersGetCoupons.js";
-import { offersGetPromotions } from "../funcs/offersGetPromotions.js";
-import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as operations from "../models/operations/index.js";
-import { unwrapAsync } from "../types/fp.js";
+import { ClientSDK } from "../lib/sdks.js";
+import { Coupons } from "./coupons.js";
+import { Promotions } from "./promotions.js";
 
 export class Offers extends ClientSDK {
-    /**
-     * Retrieve all coupons
-     *
-     * @remarks
-     * Retrieve active coupons
-     */
-    async getCoupons(options?: RequestOptions): Promise<operations.GetCouponsResponseBody> {
-        return unwrapAsync(offersGetCoupons(this, options));
+    private _coupons?: Coupons;
+    get coupons(): Coupons {
+        return (this._coupons ??= new Coupons(this.options$));
     }
 
-    /**
-     * Retrieve all promotions
-     *
-     * @remarks
-     * All active promotions
-     */
-    async getPromotions(options?: RequestOptions): Promise<operations.GetPromotionsResponseBody> {
-        return unwrapAsync(offersGetPromotions(this, options));
+    private _promotions?: Promotions;
+    get promotions(): Promotions {
+        return (this._promotions ??= new Promotions(this.options$));
     }
 }

package/src/sdk/orders.ts

@@ -5,7 +5,6 @@
 import { ordersCancel } from "../funcs/ordersCancel.js";
 import { ordersCreate } from "../funcs/ordersCreate.js";
 import { ordersGet } from "../funcs/ordersGet.js";
-import { ordersGetReturns } from "../funcs/ordersGetReturns.js";
 import { ordersList } from "../funcs/ordersList.js";
 import { ordersRetryPayment } from "../funcs/ordersRetryPayment.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -13,7 +12,6 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 import { CeStorefrontPayments } from "./cestorefrontpayments.js";
 import { Refunds } from "./refunds.js";
-import { Returns } from "./returns.js";
 import { Shipments } from "./shipments.js";
 
 export class Orders extends ClientSDK {
@@ -32,11 +30,6 @@ export class Orders extends ClientSDK {
         return (this._payments ??= new CeStorefrontPayments(this.options$));
     }
 
-    private _returns?: Returns;
-    get returns(): Returns {
-        return (this._returns ??= new Returns(this.options$));
-    }
-
     /**
      * Create order
      *
@@ -101,14 +94,4 @@ export class Orders extends ClientSDK {
     ): Promise<operations.PostRetryPaymentOrderIdResponseBody> {
         return unwrapAsync(ordersRetryPayment(this, request, options));
     }
-
-    /**
-     * Retrieve all order returns
-     *
-     * @remarks
-     * Retrieve all order returns
-     */
-    async getReturns(options?: RequestOptions): Promise<operations.GetOrdersReturnsResponseBody> {
-        return unwrapAsync(ordersGetReturns(this, options));
-    }
 }

package/src/sdk/products.ts

@@ -3,15 +3,14 @@
  */
 
 import { catalogProductsGet } from "../funcs/catalogProductsGet.js";
+import { catalogProductsGetCrossSells } from "../funcs/catalogProductsGetCrossSells.js";
+import { catalogProductsGetSimilar } from "../funcs/catalogProductsGetSimilar.js";
+import { catalogProductsGetUpsells } from "../funcs/catalogProductsGetUpsells.js";
 import { catalogProductsList } from "../funcs/catalogProductsList.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 import { CeStorefrontReviews } from "./cestorefrontreviews.js";
-import { CrossSell } from "./crosssell.js";
-import { Recommended } from "./recommended.js";
-import { Similar } from "./similar.js";
-import { UpSell } from "./upsell.js";
 import { Variants } from "./variants.js";
 
 export class Products extends ClientSDK {
@@ -25,26 +24,6 @@ export class Products extends ClientSDK {
         return (this._reviews ??= new CeStorefrontReviews(this.options$));
     }
 
-    private _similar?: Similar;
-    get similar(): Similar {
-        return (this._similar ??= new Similar(this.options$));
-    }
-
-    private _upSell?: UpSell;
-    get upSell(): UpSell {
-        return (this._upSell ??= new UpSell(this.options$));
-    }
-
-    private _crossSell?: CrossSell;
-    get crossSell(): CrossSell {
-        return (this._crossSell ??= new CrossSell(this.options$));
-    }
-
-    private _recommended?: Recommended;
-    get recommended(): Recommended {
-        return (this._recommended ??= new Recommended(this.options$));
-    }
-
     /**
      * List all products
      *
@@ -70,4 +49,43 @@ export class Products extends ClientSDK {
     ): Promise<operations.GetProductDetailsResponseBody> {
         return unwrapAsync(catalogProductsGet(this, request, options));
     }
+
+    /**
+     * Retrieve similar products
+     *
+     * @remarks
+     * Retrieves a list of products similar to a specified product based on their attributes and category. The similar products are returned sorted by relevance, with the most closely matching products appearing first. Useful for providing product recommendations to your customers.
+     */
+    async getSimilar(
+        request: operations.GetSimilarRequest,
+        options?: RequestOptions
+    ): Promise<operations.GetSimilarResponseBody> {
+        return unwrapAsync(catalogProductsGetSimilar(this, request, options));
+    }
+
+    /**
+     * Retrieve up-sell products
+     *
+     * @remarks
+     * Retrieves a list of products specified for upsell. The upsell products are returned based on product ids specified in request param.
+     */
+    async getUpsells(
+        request: operations.GetUpSellRequest,
+        options?: RequestOptions
+    ): Promise<operations.GetUpSellResponseBody> {
+        return unwrapAsync(catalogProductsGetUpsells(this, request, options));
+    }
+
+    /**
+     * Retrieve cross-sell products
+     *
+     * @remarks
+     * Retrieves a list of products specified for cross selling. The cross-sell products are returned based on product ids specified in request param.
+     */
+    async getCrossSells(
+        request: operations.GetCrossSellRequest,
+        options?: RequestOptions
+    ): Promise<operations.GetCrossSellResponseBody> {
+        return unwrapAsync(catalogProductsGetCrossSells(this, request, options));
+    }
 }

package/src/sdk/promotions.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { offersPromotionsList } from "../funcs/offersPromotionsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Promotions extends ClientSDK {
+    /**
+     * Retrieve all promotions
+     *
+     * @remarks
+     * All active promotions
+     */
+    async list(options?: RequestOptions): Promise<operations.GetPromotionsResponseBody> {
+        return unwrapAsync(offersPromotionsList(this, options));
+    }
+}

package/src/sdk/reviews.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { customersReviewsGetAll } from "../funcs/customersReviewsGetAll.js";
+import { customersReviewsList } from "../funcs/customersReviewsList.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
@@ -14,10 +14,10 @@ export class Reviews extends ClientSDK {
      * @remarks
      * Retrieve all reviews
      */
-    async getAll(
+    async list(
         request: operations.GetCustomersUserIdReviewsRequest,
         options?: RequestOptions
     ): Promise<operations.GetCustomersUserIdReviewsResponseBody> {
-        return unwrapAsync(customersReviewsGetAll(this, request, options));
+        return unwrapAsync(customersReviewsList(this, request, options));
     }
 }

package/src/sdk/sdk.ts

@@ -9,12 +9,14 @@ import { Campaigns } from "./campaigns.js";
 import { Carts } from "./carts.js";
 import { Catalog } from "./catalog.js";
 import { Checkout } from "./checkout.js";
-import { Common } from "./common.js";
 import { Customers } from "./customers.js";
+import { CustomersAPI } from "./customersapi.js";
 import { Offers } from "./offers.js";
 import { Orders } from "./orders.js";
 import { Payments } from "./payments.js";
 import { Shipping } from "./shipping.js";
+import { User } from "./user.js";
+import { Utils } from "./utils.js";
 import { Wishlist } from "./wishlist.js";
 
 export class CeStorefront extends ClientSDK {
@@ -23,6 +25,11 @@ export class CeStorefront extends ClientSDK {
         return (this._catalog ??= new Catalog(this.options$));
     }
 
+    private _customersAPI?: CustomersAPI;
+    get customersAPI(): CustomersAPI {
+        return (this._customersAPI ??= new CustomersAPI(this.options$));
+    }
+
     private _carts?: Carts;
     get carts(): Carts {
         return (this._carts ??= new Carts(this.options$));
@@ -63,14 +70,19 @@ export class CeStorefront extends ClientSDK {
         return (this._auth ??= new Auth(this.options$));
     }
 
+    private _user?: User;
+    get user(): User {
+        return (this._user ??= new User(this.options$));
+    }
+
     private _payments?: Payments;
     get payments(): Payments {
         return (this._payments ??= new Payments(this.options$));
     }
 
-    private _common?: Common;
-    get common(): Common {
-        return (this._common ??= new Common(this.options$));
+    private _utils?: Utils;
+    get utils(): Utils {
+        return (this._utils ??= new Utils(this.options$));
     }
 
     private _analytics?: Analytics;

package/src/sdk/shipping.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { shippingGetPincodeServiceability } from "../funcs/shippingGetPincodeServiceability.js";
+import { shippingCheckPincodeServiceability } from "../funcs/shippingCheckPincodeServiceability.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
@@ -14,10 +14,10 @@ export class Shipping extends ClientSDK {
      * @remarks
      * Check shipment delivery availability in an area by pincode
      */
-    async getPincodeServiceability(
+    async checkPincodeServiceability(
         request: operations.GetShipmentPincodeServiceabilityRequest,
         options?: RequestOptions
     ): Promise<operations.GetShipmentPincodeServiceabilityResponseBody> {
-        return unwrapAsync(shippingGetPincodeServiceability(this, request, options));
+        return unwrapAsync(shippingCheckPincodeServiceability(this, request, options));
     }
 }