ce-storefront 0.0.5 → 0.2.0

package/src/sdk/cestorefrontreviews.ts

@@ -9,29 +9,37 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class CeStorefrontReviews extends ClientSDK {
-    /**
-     * Retrieve product reviews
-     *
-     * @remarks
-     * Retrieves a 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));
-    }
+  /**
+   * Retrieve product reviews
+   *
+   * @remarks
+   * Retrieves a 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));
-    }
+  /**
+   * 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

@@ -18,143 +18,188 @@ 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));
-    }
+  /**
+   * 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));
-    }
+  /**
+   * 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));
-    }
+  /**
+   * 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));
-    }
+  /**
+   * 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));
-    }
+  /**
+   * 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));
-    }
+  /**
+   * 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));
-    }
+  /**
+   * 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));
-    }
+  /**
+   * 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,
+    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));
-    }
+  /**
+   * 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 | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthResetPasswordResponseBody> {
-        return unwrapAsync(authUserResetPassword(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));
-    }
+  /**
+   * 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/checkout.ts

@@ -15,107 +15,139 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Checkout extends ClientSDK {
-    /**
-     * Update cart address
-     *
-     * @remarks
-     * update billing and shipping address
-     */
-    async updateAddress(
-        request?: operations.PostCartAddressRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostCartAddressResponseBody> {
-        return unwrapAsync(checkoutUpdateAddress(this, request, options));
-    }
+  /**
+   * Update cart address
+   *
+   * @remarks
+   * update billing and shipping address
+   */
+  async updateAddress(
+    request: operations.PostCartAddressRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostCartAddressResponseBody> {
+    return unwrapAsync(checkoutUpdateAddress(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Apply coupon
-     *
-     * @remarks
-     * Apply coupon
-     */
-    async applyCoupon(
-        request?: operations.PostApplyCouponsRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostApplyCouponsResponseBody> {
-        return unwrapAsync(checkoutApplyCoupon(this, request, options));
-    }
+  /**
+   * Apply coupon
+   *
+   * @remarks
+   * Apply coupon
+   */
+  async applyCoupon(
+    request: operations.PostApplyCouponsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostApplyCouponsResponseBody> {
+    return unwrapAsync(checkoutApplyCoupon(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Remove coupon
-     *
-     * @remarks
-     * remove coupon from cart
-     */
-    async removeCoupon(
-        request?: operations.DeleteRemoveCouponsRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.DeleteRemoveCouponsResponseBody> {
-        return unwrapAsync(checkoutRemoveCoupon(this, request, options));
-    }
+  /**
+   * Remove coupon
+   *
+   * @remarks
+   * remove coupon from cart
+   */
+  async removeCoupon(
+    request: operations.DeleteRemoveCouponsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteRemoveCouponsResponseBody> {
+    return unwrapAsync(checkoutRemoveCoupon(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Redeem loyalty points
-     *
-     * @remarks
-     * Redeem loyalty points
-     */
-    async redeemLoyaltyPoints(
-        request?: operations.PostLoyaltyPointsRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostLoyaltyPointsResponseBody> {
-        return unwrapAsync(checkoutRedeemLoyaltyPoints(this, request, options));
-    }
+  /**
+   * Redeem loyalty points
+   *
+   * @remarks
+   * Redeem loyalty points
+   */
+  async redeemLoyaltyPoints(
+    request: operations.PostLoyaltyPointsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostLoyaltyPointsResponseBody> {
+    return unwrapAsync(checkoutRedeemLoyaltyPoints(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Remove loyalty points
-     *
-     * @remarks
-     * Remove loyalty points applied in cart
-     */
-    async removeLoyaltyPoints(
-        request?: operations.DeleteLoyaltyPointsRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.DeleteLoyaltyPointsResponseBody> {
-        return unwrapAsync(checkoutRemoveLoyaltyPoints(this, request, options));
-    }
+  /**
+   * Remove loyalty points
+   *
+   * @remarks
+   * Remove loyalty points applied in cart
+   */
+  async removeLoyaltyPoints(
+    request: operations.DeleteLoyaltyPointsRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteLoyaltyPointsResponseBody> {
+    return unwrapAsync(checkoutRemoveLoyaltyPoints(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Use credit balance
-     *
-     * @remarks
-     * Use credit balance
-     */
-    async useCreditBalance(
-        request?: operations.PostCreditBalanceRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostCreditBalanceResponseBody> {
-        return unwrapAsync(checkoutUseCreditBalance(this, request, options));
-    }
+  /**
+   * Use credit balance
+   *
+   * @remarks
+   * Use credit balance
+   */
+  async useCreditBalance(
+    request: operations.PostCreditBalanceRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostCreditBalanceResponseBody> {
+    return unwrapAsync(checkoutUseCreditBalance(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Remove credit balance
-     *
-     * @remarks
-     * remove credit balance applied to cart
-     */
-    async removeCreditBalance(
-        request?: operations.DeleteCreditBalanceRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.DeleteCreditBalanceResponseBody> {
-        return unwrapAsync(checkoutRemoveCreditBalance(this, request, options));
-    }
+  /**
+   * Remove credit balance
+   *
+   * @remarks
+   * remove credit balance applied to cart
+   */
+  async removeCreditBalance(
+    request: operations.DeleteCreditBalanceRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteCreditBalanceResponseBody> {
+    return unwrapAsync(checkoutRemoveCreditBalance(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Redeem gift card
-     *
-     * @remarks
-     * Redeem a gift card
-     */
-    async redeemGiftCard(
-        request?: operations.PostCheckoutRedeemGiftCardRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostCheckoutRedeemGiftCardResponseBody> {
-        return unwrapAsync(checkoutRedeemGiftCard(this, request, options));
-    }
+  /**
+   * Redeem gift card
+   *
+   * @remarks
+   * Redeem a gift card
+   */
+  async redeemGiftCard(
+    request: operations.PostCheckoutRedeemGiftCardRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostCheckoutRedeemGiftCardResponseBody> {
+    return unwrapAsync(checkoutRedeemGiftCard(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/coupons.ts

@@ -8,13 +8,18 @@ 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));
-    }
+  /**
+   * Retrieve all coupons
+   *
+   * @remarks
+   * Retrieve active coupons
+   */
+  async list(
+    options?: RequestOptions,
+  ): Promise<operations.GetCouponsResponseBody> {
+    return unwrapAsync(offersCouponsList(
+      this,
+      options,
+    ));
+  }
 }