oneentry 1.0.137 → 1.0.138

package/dist/payments/paymentsApi.d.ts

@@ -21,8 +21,8 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * @handleName getSessions
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit]  - Optional parameter for pagination. Default: 30.
-     * @returns {ISessionsEntity} Returns an array of SessionEntity objects.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ISessionsEntity | IError>} Returns an array of SessionEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets list of payment sessions. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
@@ -31,8 +31,8 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * Get a single payment session object by its identifier.
      * @handleName getSessionById
      * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
-     * @returns {ISessionEntity} Returns a single payment session object.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ISessionEntity | IError>} Returns a single payment session object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets a single payment session object by its identifier. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
@@ -41,20 +41,20 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * Get one payment session object by order identifier
      * @handleName getSessionByOrderId
      * @param {number} id - Order identifier. Example: 12345.
-     * @returns {IAccountsEntity} Returns a single payment account object.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IAccountsEntity | IError>} Returns a single payment account object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets one payment session object by order identifier. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
-    getSessionByOrderId(id: number): Promise<ISessionEntity | IError>;
+    getSessionByOrderId(id: number): Promise<ISessionEntity | ISessionEntity[] | IError>;
     /**
      * Creation of payment session.
      * @handleName createSession
      * @param {number} orderId - Order identifier. Example: 12345.
      * @param {'session' | 'intent'} type - Session type. Possible values: "session" or "intent". Example:  'session'.
      * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
-     * @returns {ICreateSessionEntity} Returns a single payment session object.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICreateSessionEntity | IError>} Returns a single payment session object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method creates a payment session. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
@@ -62,8 +62,8 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
     /**
      * Get all payment accounts as an array.
      * @handleName getAccounts
-     * @returns {IAccountsEntity} Returns all created payment accounts as an array of PaymentAccountEntity objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IAccountsEntity | IError>} Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets all payment accounts as an array. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
@@ -72,8 +72,8 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * Get a single payment account object by its identifier.
      * @handleName getAccountById
      * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
-     * @returns {IAccountsEntity} Returns a single payment account object.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IAccountsEntity | IError>} Returns a single payment account object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get a single payment account object by its identifier.
      * @description This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.

package/dist/payments/paymentsApi.js

@@ -25,8 +25,8 @@ class PaymentsApi extends asyncModules_1.default {
      * @handleName getSessions
      * @param {number} [offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [limit]  - Optional parameter for pagination. Default: 30.
-     * @returns {ISessionsEntity} Returns an array of SessionEntity objects.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ISessionsEntity | IError>} Returns an array of SessionEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets list of payment sessions. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
@@ -44,8 +44,8 @@ class PaymentsApi extends asyncModules_1.default {
      * Get a single payment session object by its identifier.
      * @handleName getSessionById
      * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
-     * @returns {ISessionEntity} Returns a single payment session object.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ISessionEntity | IError>} Returns a single payment session object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets a single payment session object by its identifier. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
@@ -57,8 +57,8 @@ class PaymentsApi extends asyncModules_1.default {
      * Get one payment session object by order identifier
      * @handleName getSessionByOrderId
      * @param {number} id - Order identifier. Example: 12345.
-     * @returns {IAccountsEntity} Returns a single payment account object.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IAccountsEntity | IError>} Returns a single payment account object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets one payment session object by order identifier. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
@@ -74,8 +74,8 @@ class PaymentsApi extends asyncModules_1.default {
      * @param {number} orderId - Order identifier. Example: 12345.
      * @param {'session' | 'intent'} type - Session type. Possible values: "session" or "intent". Example:  'session'.
      * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
-     * @returns {ICreateSessionEntity} Returns a single payment session object.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<ICreateSessionEntity | IError>} Returns a single payment session object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method creates a payment session. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
@@ -92,8 +92,8 @@ class PaymentsApi extends asyncModules_1.default {
     /**
      * Get all payment accounts as an array.
      * @handleName getAccounts
-     * @returns {IAccountsEntity} Returns all created payment accounts as an array of PaymentAccountEntity objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IAccountsEntity | IError>} Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets all payment accounts as an array. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
@@ -107,8 +107,8 @@ class PaymentsApi extends asyncModules_1.default {
      * Get a single payment account object by its identifier.
      * @handleName getAccountById
      * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
-     * @returns {IAccountsEntity} Returns a single payment account object.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IAccountsEntity | IError>} Returns a single payment account object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get a single payment account object by its identifier.
      * @description This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.

package/dist/payments/paymentsInterfaces.d.ts

@@ -40,7 +40,7 @@ interface IPaymentsApi {
      * @description This method gets one payment session object by order identifier. This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
-    getSessionByOrderId(id: number): Promise<ISessionEntity | IError>;
+    getSessionByOrderId(id: number): Promise<ISessionEntity | ISessionEntity[] | IError>;
     /**
      * Creation of payment session.
      * @handleName createSession
@@ -106,6 +106,7 @@ interface ISessionsEntity {
  * @property {number} paymentAccountId - Payment ID from an external provider. Example: "9BE88048TU058770M".
  * @property {number} orderId - Order identifier. Example: 1.
  * @property {string | null} paymentUrl - payment link. Example: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M".
+ * @property {number | null} [amount] - Amount of the payment session. Example: 100.
  * @description This interface defines the structure of a session entity, including its quantity, amount, currency, name, and description.
  */
 interface ISessionEntity {
@@ -117,6 +118,7 @@ interface ISessionEntity {
     paymentAccountId: number;
     orderId: number;
     paymentUrl: string | null;
+    amount?: number | null;
 }
 /**
  * @interface IIntent
@@ -174,6 +176,10 @@ interface ICreateSessionEntity {
  * @property {'stripe' | 'custom'} type - Type may be 'stripe' or 'custom'. Example: 'stripe'.
  * @property {boolean} isVisible - Visibility indicator of the payment account. Example: true.
  * @property {boolean} isUsed - Usage indicator of the payment account. Example: false.
+ * @property {boolean} testMode - Indicates whether the payment account is in test mode. Example: true.
+ * @property {object} settings - Payment account settings. Example: {}.
+ * @property {object} [testSettings] - Test mode settings for the payment account. Example: {}.
+ * @property {string} updatedDate - Object modification date. Example: "2025-02-26T10:13:16.839Z".
  * @description This interface defines the structure of a payment account entity, including its identifiers, localization information, type, visibility, and usage status.
  */
 interface IAccountsEntity {
@@ -184,7 +190,7 @@ interface IAccountsEntity {
     isVisible: boolean;
     isUsed: boolean;
     testMode: boolean;
-    settings: any;
+    settings: object;
     testSettings?: {
         cancelUrl?: string;
         successUrl?: string;

package/dist/payments/paymentsSchemas.d.ts

@@ -7,7 +7,7 @@ export declare const PaymentSessionSchema: z.ZodObject<{
     id: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
     orderId: z.ZodOptional<z.ZodNumber>;
     orderIdentifier: z.ZodOptional<z.ZodString>;
-    amount: z.ZodOptional<z.ZodNumber>;
+    amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     currency: z.ZodOptional<z.ZodString>;
     status: z.ZodString;
     paymentMethod: z.ZodOptional<z.ZodString>;
@@ -29,7 +29,7 @@ export declare const PaymentSessionsResponseSchema: z.ZodObject<{
         id: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
         orderId: z.ZodOptional<z.ZodNumber>;
         orderIdentifier: z.ZodOptional<z.ZodString>;
-        amount: z.ZodOptional<z.ZodNumber>;
+        amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         currency: z.ZodOptional<z.ZodString>;
         status: z.ZodString;
         paymentMethod: z.ZodOptional<z.ZodString>;
@@ -46,13 +46,13 @@ export declare const PaymentSessionsResponseSchema: z.ZodObject<{
 }, z.core.$strip>;
 /**
  * Single payment session response schema
- * @description Schema for a single payment session
+ * @description Schema for a single payment session or array of sessions by order
  */
-export declare const SinglePaymentSessionSchema: z.ZodObject<{
+export declare const SinglePaymentSessionSchema: z.ZodUnion<readonly [z.ZodObject<{
     id: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
     orderId: z.ZodOptional<z.ZodNumber>;
     orderIdentifier: z.ZodOptional<z.ZodString>;
-    amount: z.ZodOptional<z.ZodNumber>;
+    amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     currency: z.ZodOptional<z.ZodString>;
     status: z.ZodString;
     paymentMethod: z.ZodOptional<z.ZodString>;
@@ -64,7 +64,23 @@ export declare const SinglePaymentSessionSchema: z.ZodObject<{
     type: z.ZodOptional<z.ZodString>;
     paymentAccountId: z.ZodOptional<z.ZodNumber>;
     paymentUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, z.core.$strip>;
+}, z.core.$strip>, z.ZodArray<z.ZodObject<{
+    id: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+    orderId: z.ZodOptional<z.ZodNumber>;
+    orderIdentifier: z.ZodOptional<z.ZodString>;
+    amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    currency: z.ZodOptional<z.ZodString>;
+    status: z.ZodString;
+    paymentMethod: z.ZodOptional<z.ZodString>;
+    createdDate: z.ZodOptional<z.ZodString>;
+    updatedDate: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodOptional<z.ZodString>;
+    expiresAt: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    type: z.ZodOptional<z.ZodString>;
+    paymentAccountId: z.ZodOptional<z.ZodNumber>;
+    paymentUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>>]>;
 /**
  * Payment account schema
  * @description Schema for a payment account

package/dist/payments/paymentsSchemas.js

@@ -10,7 +10,7 @@ exports.PaymentSessionSchema = zod_1.z.object({
     id: zod_1.z.union([zod_1.z.string(), zod_1.z.number()]),
     orderId: zod_1.z.number().optional(),
     orderIdentifier: zod_1.z.string().optional(),
-    amount: zod_1.z.number().optional(),
+    amount: zod_1.z.number().nullable().optional(),
     currency: zod_1.z.string().optional(),
     status: zod_1.z.string(),
     paymentMethod: zod_1.z.string().optional(),
@@ -33,9 +33,12 @@ exports.PaymentSessionsResponseSchema = zod_1.z.object({
 });
 /**
  * Single payment session response schema
- * @description Schema for a single payment session
+ * @description Schema for a single payment session or array of sessions by order
  */
-exports.SinglePaymentSessionSchema = exports.PaymentSessionSchema;
+exports.SinglePaymentSessionSchema = zod_1.z.union([
+    exports.PaymentSessionSchema,
+    zod_1.z.array(exports.PaymentSessionSchema),
+]);
 /**
  * Payment account schema
  * @description Schema for a payment account

package/dist/product-statuses/productStatusesApi.d.ts

@@ -20,8 +20,8 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
      * Search for all product status objects.
      * @handleName getProductStatuses
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IProductStatusEntity[]} Returns an array of product status objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductStatusEntity[] | IError>} Returns an array of product status objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for all product status objects.
      */
     getProductStatuses(langCode?: string): Promise<IProductStatusEntity[] | IError>;
@@ -30,8 +30,8 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
      * @handleName getProductsByStatusMarker
      * @param {string} marker - Product marker. Example: "in_stock".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IProductStatusEntity} Returns a product status object.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for a product status object by its textual identifier (marker).
      */
     getProductsByStatusMarker(marker: string, langCode?: string): Promise<IProductStatusEntity | IError>;
@@ -39,8 +39,8 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
      * Check the existence of a textual identifier.
      * @handleName validateMarker
      * @param {string} marker - Product marker. Example: "in_stock".
-     * @returns {boolean} Returns true if the textual identifier (marker) exists or false if it doesn't.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<boolean | IError>} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Check the existence of a textual identifier.
      */
     validateMarker(marker: string): Promise<boolean | IError>;

package/dist/product-statuses/productStatusesApi.js

@@ -24,8 +24,8 @@ class ProductStatusesApi extends asyncModules_1.default {
      * Search for all product status objects.
      * @handleName getProductStatuses
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IProductStatusEntity[]} Returns an array of product status objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductStatusEntity[] | IError>} Returns an array of product status objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for all product status objects.
      */
     async getProductStatuses(langCode = this.state.lang) {
@@ -39,8 +39,8 @@ class ProductStatusesApi extends asyncModules_1.default {
      * @handleName getProductsByStatusMarker
      * @param {string} marker - Product marker. Example: "in_stock".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IProductStatusEntity} Returns a product status object.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for a product status object by its textual identifier (marker).
      */
     async getProductsByStatusMarker(marker, langCode = this.state.lang) {
@@ -53,8 +53,8 @@ class ProductStatusesApi extends asyncModules_1.default {
      * Check the existence of a textual identifier.
      * @handleName validateMarker
      * @param {string} marker - Product marker. Example: "in_stock".
-     * @returns {boolean} Returns true if the textual identifier (marker) exists or false if it doesn't.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<boolean | IError>} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Check the existence of a textual identifier.
      */
     async validateMarker(marker) {

package/dist/products/productsApi.d.ts

@@ -49,18 +49,19 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      * @example
         {
-          "limit": 30,
-          "offset": 0,
+          "signPrice": "orders",
           "sortOrder": "DESC",
           "sortKey": "id",
+          "limit": 30,
+          "offset": 0,
           "statusId": 123,
           "statusMarker": "in_stock",
           "conditionValue": "new",
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @returns {IProductsResponse} Array with ProductEntity objects
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsResponse | IError>} Products response, or IError when isShell=true
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch products with optional filters and pagination.
      */
     getProducts(body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
@@ -81,8 +82,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @returns {IProductsResponse} Array with ProductEntity objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for all product page objects with pagination that do not have a category.
      */
     getProductsEmptyPage(langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
@@ -129,8 +130,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @returns {IProductsResponse} Array with ProductEntity objects
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch products by page ID with optional filters and pagination.
      */
     getProductsByPageId(id: number, body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
@@ -152,8 +153,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @returns {IProductsInfo} Array with ProductInformation objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsInfo | IError>} Array with ProductInformation objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for information about products and prices for the selected category.
      */
     getProductsPriceByPageUrl(url: string, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsInfo | IError>;
@@ -200,8 +201,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @returns {IProductsResponse} Array with ProductEntity objects.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for all products with pagination for the selected category.
      */
     getProductsByPageUrl(url: string, body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
@@ -227,8 +228,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
      * @param {string} [userQuery.sortOrder] - Optional sorting order "DESC" | "ASC". Example: "DESC".
      * @param {string} [userQuery.sortKey] - Optional field to sort by ("id", "title", "date", "price", "position", "status"). Example: "id".
-     * @returns {IProductsResponse} Array with ProductEntity objects
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Find all related product page objects.
      */
     getRelatedProductsById(id: number, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
@@ -259,8 +260,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched. Example: "new".
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered. Example: "equals".
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered. Example: "color".
-     * @returns {IProductsEntity[]} Array with ProductEntity objects
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsEntity[] | IError>} Array with ProductEntity objects
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Find products by its ids.
      */
     getProductsByIds(ids: string, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsEntity[] | IError>;
@@ -269,8 +270,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * @handleName getProductById
      * @param {number} id - Product id. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IProductsEntity} ProductEntity object.
-     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsEntity | IError>} ProductEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Retrieve one product object.
      */
     getProductById(id: number, langCode?: string): Promise<IProductsEntity | IError>;
@@ -278,8 +279,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * Getting a product block object by product id.
      * @handleName getProductBlockById
      * @param {number} id - Product id. Example: 12345.
-     * @returns {IProductBlock} - Product block object.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductBlock | IError>} - Product block object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting a product block object by product id.
      */
     getProductBlockById(id: number): Promise<IProductBlock[] | IError>;
@@ -288,8 +289,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * @handleName searchProduct
      * @param {string} name - Text to search product page objects (search is based on the title field of the localizeInfos object with language consideration). Example: "laminat".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {IProductsEntity[]} Array with ProductEntity objects
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsEntity[] | IError>} Array with ProductEntity objects
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Quick search for product page objects with limited output.
      */
     searchProduct(name: string, langCode?: string): Promise<IProductsEntity[] | IError>;
@@ -310,8 +311,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
             "title": "Iphone 17 Pro"
           }
         ]
-     * @returns {IProductsCount} Object with product items count.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsCount | IError>} Object with product items count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method calculates and returns the total number of products present across the entire catalog, optionally applying specified filters.
      */
     getProductsCount(body?: any[]): Promise<IProductsCount | IError>;
@@ -333,8 +334,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
             "title": "Iphone 17 Pro"
           }
         ]
-     * @returns {IProductsCount} Object with product items count.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsCount | IError>} Object with product items count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method calculates and returns the number of products available on a given catalog page, identified by its page ID, with optional filtering.
      */
     getProductsCountByPageId(id: string, body?: any[]): Promise<IProductsCount | IError>;
@@ -356,8 +357,8 @@ export default class ProductApi extends AsyncModules implements IProductApi {
             "title": "Iphone 17 Pro"
           }
         ]
-     * @returns {IProductsCount} Object with product items count.
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @returns {Promise<IProductsCount | IError>} Object with product items count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method calculates and returns the number of products available on a given catalog page, identified by its URL, with optional filtering.
      */
     getProductsCountByPageUrl(url: string, body?: any[]): Promise<IProductsCount | IError>;