ce-storefront 0.0.5 → 0.2.0

package/src/sdk/auth.ts

@@ -21,182 +21,233 @@ import { unwrapAsync } from "../types/fp.js";
 import { CeStorefrontUser } from "./cestorefrontuser.js";
 
 export class Auth extends ClientSDK {
-    private _user?: CeStorefrontUser;
-    get user(): CeStorefrontUser {
-        return (this._user ??= new CeStorefrontUser(this.options$));
-    }
+  private _user?: CeStorefrontUser;
+  get user(): CeStorefrontUser {
+    return (this._user ??= new CeStorefrontUser(this._options));
+  }
 
-    /**
-     * Anonymous user
-     *
-     * @remarks
-     * This API’s focus is on anonymous users who have not undergone the formal account creation process. These anonymous users are associated with a unique identifier called a ULID, ensuring that even in the absence of a fully realized account, there is a distinct and trackable identity for each user.
-     * To interact with the system, each anonymous user is issued an access token. This access token plays a dual role in the system: it serves as a means of authenticating the user and it also acts as a tool for authorization, determining what actions the authenticated user is permitted to perform.
-     */
-    async loginAnonymously(
-        security: operations.PostAuthAnonymousSecurity,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthAnonymousResponseBody> {
-        return unwrapAsync(authLoginAnonymously(this, security, options));
-    }
+  /**
+   * Anonymous user
+   *
+   * @remarks
+   * This API’s focus is on anonymous users who have not undergone the formal account creation process. These anonymous users are associated with a unique identifier called a ULID, ensuring that even in the absence of a fully realized account, there is a distinct and trackable identity for each user.
+   * To interact with the system, each anonymous user is issued an access token. This access token plays a dual role in the system: it serves as a means of authenticating the user and it also acts as a tool for authorization, determining what actions the authenticated user is permitted to perform.
+   */
+  async loginAnonymously(
+    security: operations.PostAuthAnonymousSecurity,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthAnonymousResponseBody> {
+    return unwrapAsync(authLoginAnonymously(
+      this,
+      security,
+      options,
+    ));
+  }
 
-    /**
-     * Login with phone
-     *
-     * @remarks
-     * This API enables users to authenticate into the system using their phone number. It provides a secure way for users to log in by verifying their identity through a one-time password (OTP) sent to their registered phone.
-     */
-    async loginWithPhone(
-        request?: operations.PostAuthLoginPhoneRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthLoginPhoneResponseBody> {
-        return unwrapAsync(authLoginWithPhone(this, request, options));
-    }
+  /**
+   * Login with phone
+   *
+   * @remarks
+   * This API enables users to authenticate into the system using their phone number. It provides a secure way for users to log in by verifying their identity through a one-time password (OTP) sent to their registered phone.
+   */
+  async loginWithPhone(
+    request: operations.PostAuthLoginPhoneRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthLoginPhoneResponseBody> {
+    return unwrapAsync(authLoginWithPhone(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Login with email
-     *
-     * @remarks
-     * This API enables users to authenticate into the system using their email address. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their email address.
-     */
-    async loginWithEmail(
-        request?: operations.PostAuthLoginEmailRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthLoginEmailResponseBody> {
-        return unwrapAsync(authLoginWithEmail(this, request, options));
-    }
+  /**
+   * Login with email
+   *
+   * @remarks
+   * This API enables users to authenticate into the system using their email address. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their email address.
+   */
+  async loginWithEmail(
+    request: operations.PostAuthLoginEmailRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthLoginEmailResponseBody> {
+    return unwrapAsync(authLoginWithEmail(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Login with whatsapp
-     *
-     * @remarks
-     * This API enables users to authenticate into the system using their WhatsApp Number. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their WhatsApp Number.
-     */
-    async loginWithWhatsapp(
-        request?: operations.PostAuthLoginWhatsappRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthLoginWhatsappResponseBody> {
-        return unwrapAsync(authLoginWithWhatsapp(this, request, options));
-    }
+  /**
+   * Login with whatsapp
+   *
+   * @remarks
+   * This API enables users to authenticate into the system using their WhatsApp Number. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their WhatsApp Number.
+   */
+  async loginWithWhatsapp(
+    request: operations.PostAuthLoginWhatsappRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthLoginWhatsappResponseBody> {
+    return unwrapAsync(authLoginWithWhatsapp(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Login with password
-     *
-     * @remarks
-     * This API endpoint allows users to Login using their password. It requires the following parameters: email/phone and password. Also allows users to securely Login and obtain access and refresh tokens for subsequent API calls.
-     */
-    async loginWithPassword(
-        request?: operations.PostAuthLoginPasswordRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthLoginPasswordResponseBody> {
-        return unwrapAsync(authLoginWithPassword(this, request, options));
-    }
+  /**
+   * Login with password
+   *
+   * @remarks
+   * This API endpoint allows users to Login using their password. It requires the following parameters: email/phone and password. Also allows users to securely Login and obtain access and refresh tokens for subsequent API calls.
+   */
+  async loginWithPassword(
+    request: operations.PostAuthLoginPasswordRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthLoginPasswordResponseBody> {
+    return unwrapAsync(authLoginWithPassword(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Verify OTP
-     *
-     * @remarks
-     * This API endpoint allows you to verify a one-time password (OTP) for authentication purposes. By sending a request to this endpoint with the necessary parameters, you can confirm the validity of the OTP provided by the user.
-     */
-    async verifyOtp(
-        request?: operations.PostAuthVerifyOtpRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthVerifyOtpResponseBody> {
-        return unwrapAsync(authVerifyOtp(this, request, options));
-    }
+  /**
+   * Verify OTP
+   *
+   * @remarks
+   * This API endpoint allows you to verify a one-time password (OTP) for authentication purposes. By sending a request to this endpoint with the necessary parameters, you can confirm the validity of the OTP provided by the user.
+   */
+  async verifyOtp(
+    request: operations.PostAuthVerifyOtpRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthVerifyOtpResponseBody> {
+    return unwrapAsync(authVerifyOtp(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Register with phone
-     *
-     * @remarks
-     * This API provides the functionality to register a user using their phone number. This allows you to securely register users and obtain access and refresh tokens for subsequent API calls.
-     */
-    async registerWithPhone(
-        request?: operations.PostAuthRegisterPhoneRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthRegisterPhoneResponseBody> {
-        return unwrapAsync(authRegisterWithPhone(this, request, options));
-    }
+  /**
+   * Register with phone
+   *
+   * @remarks
+   * This API provides the functionality to register a user using their phone number. This allows you to securely register users and obtain access and refresh tokens for subsequent API calls.
+   */
+  async registerWithPhone(
+    request: operations.PostAuthRegisterPhoneRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthRegisterPhoneResponseBody> {
+    return unwrapAsync(authRegisterWithPhone(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Register with email
-     *
-     * @remarks
-     * The API allows users to register with their email address. This endpoint enables the registration process by requesting the user's email, first name, last name, phone number, and OTP token.
-     * The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user's information, access token and refresh token.
-     */
-    async registerWithEmail(
-        request?: operations.PostAuthRegisterEmailRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthRegisterEmailResponseBody> {
-        return unwrapAsync(authRegisterWithEmail(this, request, options));
-    }
+  /**
+   * Register with email
+   *
+   * @remarks
+   * The API allows users to register with their email address. This endpoint enables the registration process by requesting the user's email, first name, last name, phone number, and OTP token.
+   * The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user's information, access token and refresh token.
+   */
+  async registerWithEmail(
+    request: operations.PostAuthRegisterEmailRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthRegisterEmailResponseBody> {
+    return unwrapAsync(authRegisterWithEmail(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Register with whatsapp
-     *
-     * @remarks
-     * The API allows users to register with their WhatsApp. This endpoint enables the registration process by requesting the user's WhatsApp number, first name, last name, email, and OTP token.
-     * The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user's information, access token and refresh token.
-     *
-     */
-    async registerWithWhatsapp(
-        request?: operations.PostAuthRegisterWhatsappRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthRegisterWhatsappResponseBody> {
-        return unwrapAsync(authRegisterWithWhatsapp(this, request, options));
-    }
+  /**
+   * Register with whatsapp
+   *
+   * @remarks
+   * The API allows users to register with their WhatsApp. This endpoint enables the registration process by requesting the user's WhatsApp number, first name, last name, email, and OTP token.
+   * The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user's information, access token and refresh token.
+   */
+  async registerWithWhatsapp(
+    request: operations.PostAuthRegisterWhatsappRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthRegisterWhatsappResponseBody> {
+    return unwrapAsync(authRegisterWithWhatsapp(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Register with password
-     *
-     * @remarks
-     * The User Registration with Password API facilitates user onboarding by allowing registration through a combination of phone number and email. API collects essential registration details, including phone number, email, password and the confirmation of the chosen password.
-     * The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user's information, access token and refresh token.
-     */
-    async registerWithPassword(
-        request?: operations.PostAuthRegisterPasswordRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthRegisterPasswordResponseBody> {
-        return unwrapAsync(authRegisterWithPassword(this, request, options));
-    }
+  /**
+   * Register with password
+   *
+   * @remarks
+   * The User Registration with Password API facilitates user onboarding by allowing registration through a combination of phone number and email. API collects essential registration details, including phone number, email, password and the confirmation of the chosen password.
+   * The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user's information, access token and refresh token.
+   */
+  async registerWithPassword(
+    request: operations.PostAuthRegisterPasswordRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthRegisterPasswordResponseBody> {
+    return unwrapAsync(authRegisterWithPassword(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Refresh access token
-     *
-     * @remarks
-     * The Refresh Access Token API is an integral component designed to enhance security and user experience. It enables clients to refresh their access tokens seamlessly, extending user sessions without compromising security.
-     */
-    async refreshToken(
-        request?: operations.PostAuthRefreshTokenRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthRefreshTokenResponseBody> {
-        return unwrapAsync(authRefreshToken(this, request, options));
-    }
+  /**
+   * Refresh access token
+   *
+   * @remarks
+   * The Refresh Access Token API is an integral component designed to enhance security and user experience. It enables clients to refresh their access tokens seamlessly, extending user sessions without compromising security.
+   */
+  async refreshToken(
+    request: operations.PostAuthRefreshTokenRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthRefreshTokenResponseBody> {
+    return unwrapAsync(authRefreshToken(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Generate OTP
-     *
-     * @remarks
-     * Generating a One-Time Password (OTP) typically involves creating a random code that is sent to a user for authentication or verification purposes.
-     */
-    async generateOtp(
-        request?: operations.PostAuthGenerateOtpRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthGenerateOtpResponseBody> {
-        return unwrapAsync(authGenerateOtp(this, request, options));
-    }
+  /**
+   * Generate OTP
+   *
+   * @remarks
+   * Generating a One-Time Password (OTP) typically involves creating a random code that is sent to a user for authentication or verification purposes.
+   */
+  async generateOtp(
+    request: operations.PostAuthGenerateOtpRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthGenerateOtpResponseBody> {
+    return unwrapAsync(authGenerateOtp(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Check verified email phone
-     *
-     * @remarks
-     * The Check Verification Status API allows to verify the status of email and phone number verification for a specific user. Upon a successful request, the API responds with the verification status of the provided email and phone number. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.
-     */
-    async verifyEmailPhone(
-        request?: operations.PostAuthVerifiedEmailPhoneRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostAuthVerifiedEmailPhoneResponseBody> {
-        return unwrapAsync(authVerifyEmailPhone(this, request, options));
-    }
+  /**
+   * Check verified email phone
+   *
+   * @remarks
+   * The Check Verification Status API allows to verify the status of email and phone number verification for a specific user. Upon a successful request, the API responds with the verification status of the provided email and phone number. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.
+   */
+  async verifyEmailPhone(
+    request: operations.PostAuthVerifiedEmailPhoneRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostAuthVerifiedEmailPhoneResponseBody> {
+    return unwrapAsync(authVerifyEmailPhone(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/campaigns.ts

@@ -6,8 +6,8 @@ import { ClientSDK } from "../lib/sdks.js";
 import { Newsletter } from "./newsletter.js";
 
 export class Campaigns extends ClientSDK {
-    private _newsletter?: Newsletter;
-    get newsletter(): Newsletter {
-        return (this._newsletter ??= new Newsletter(this.options$));
-    }
+  private _newsletter?: Newsletter;
+  get newsletter(): Newsletter {
+    return (this._newsletter ??= new Newsletter(this._options));
+  }
 }

package/src/sdk/carts.ts

@@ -11,55 +11,71 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Carts extends ClientSDK {
-    /**
-     * Create cart
-     *
-     * @remarks
-     * Create cart
-     */
-    async create(
-        request?: operations.PostCartsIdRequestBody | undefined,
-        options?: RequestOptions
-    ): Promise<operations.PostCartsIdResponseBody> {
-        return unwrapAsync(cartsCreate(this, request, options));
-    }
+  /**
+   * Create cart
+   *
+   * @remarks
+   * Create cart
+   */
+  async create(
+    request: operations.PostCartsIdRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.PostCartsIdResponseBody> {
+    return unwrapAsync(cartsCreate(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Retrieve cart details
-     *
-     * @remarks
-     * Retrieve cart detail
-     */
-    async get(
-        request: operations.GetCartRequest,
-        options?: RequestOptions
-    ): Promise<operations.GetCartResponseBody> {
-        return unwrapAsync(cartsGet(this, request, options));
-    }
+  /**
+   * Retrieve cart details
+   *
+   * @remarks
+   * Retrieve cart detail
+   */
+  async get(
+    request: operations.GetCartRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetCartResponseBody> {
+    return unwrapAsync(cartsGet(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Delete cart
-     *
-     * @remarks
-     * delete all items from the cart.
-     */
-    async delete(
-        request: operations.DeleteCartIdRequest,
-        options?: RequestOptions
-    ): Promise<operations.DeleteCartIdResponseBody> {
-        return unwrapAsync(cartsDelete(this, request, options));
-    }
+  /**
+   * Delete cart
+   *
+   * @remarks
+   * delete all items from the cart.
+   */
+  async delete(
+    request: operations.DeleteCartIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteCartIdResponseBody> {
+    return unwrapAsync(cartsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
 
-    /**
-     * Add/delete cart item
-     *
-     * @remarks
-     * Add Item to cart. To delete item from cart, pass quantity = 0
-     */
-    async addItem(
-        request: operations.PostCartItemIdRequest,
-        options?: RequestOptions
-    ): Promise<operations.PostCartItemIdResponseBody> {
-        return unwrapAsync(cartsAddItem(this, request, options));
-    }
+  /**
+   * Add/delete cart item
+   *
+   * @remarks
+   * Add Item to cart. To delete item from cart, pass quantity = 0
+   */
+  async addItem(
+    request: operations.PostCartItemIdRequest,
+    options?: RequestOptions,
+  ): Promise<operations.PostCartItemIdResponseBody> {
+    return unwrapAsync(cartsAddItem(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/catalog.ts

@@ -8,18 +8,18 @@ import { Products } from "./products.js";
 import { Skus } from "./skus.js";
 
 export class Catalog extends ClientSDK {
-    private _products?: Products;
-    get products(): Products {
-        return (this._products ??= new Products(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 _skus?: Skus;
+  get skus(): Skus {
+    return (this._skus ??= new Skus(this._options));
+  }
 
-    private _categories?: Categories;
-    get categories(): Categories {
-        return (this._categories ??= new Categories(this.options$));
-    }
+  private _categories?: Categories;
+  get categories(): Categories {
+    return (this._categories ??= new Categories(this._options));
+  }
 }

package/src/sdk/categories.ts

@@ -8,16 +8,20 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Categories extends ClientSDK {
-    /**
-     * List all categories
-     *
-     * @remarks
-     * Returns a list of your product categories. The categories are returned sorted by creation date, with the most recently created categories appearing first.
-     */
-    async list(
-        request: operations.GetProductsCategoriesRequest,
-        options?: RequestOptions
-    ): Promise<operations.GetProductsCategoriesResponseBody> {
-        return unwrapAsync(catalogCategoriesList(this, request, options));
-    }
+  /**
+   * List all categories
+   *
+   * @remarks
+   * Returns a list of your product categories. The categories are returned sorted by creation date, with the most recently created categories appearing first.
+   */
+  async list(
+    request: operations.GetProductsCategoriesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetProductsCategoriesResponseBody> {
+    return unwrapAsync(catalogCategoriesList(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/cestorefrontpayments.ts

@@ -8,16 +8,20 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class CeStorefrontPayments extends ClientSDK {
-    /**
-     * Retrieve order payments
-     *
-     * @remarks
-     * Retrieve order payments
-     */
-    async list(
-        request: operations.GetOrdersIdPaymentsRequest,
-        options?: RequestOptions
-    ): Promise<operations.GetOrdersIdPaymentsResponseBody> {
-        return unwrapAsync(ordersPaymentsList(this, request, options));
-    }
+  /**
+   * Retrieve order payments
+   *
+   * @remarks
+   * Retrieve order payments
+   */
+  async list(
+    request: operations.GetOrdersIdPaymentsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetOrdersIdPaymentsResponseBody> {
+    return unwrapAsync(ordersPaymentsList(
+      this,
+      request,
+      options,
+    ));
+  }
 }