oneentry 1.0.175 → 1.0.177

package/esm/payments/paymentsSchemas.d.ts

@@ -5,7 +5,7 @@ import { z } from 'zod';
  */
 export declare const PaymentSessionSchema: z.ZodObject<{
     id: z.ZodNumber;
-    orderId: z.ZodNumber;
+    orderId: z.ZodNullable<z.ZodNumber>;
     amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     status: z.ZodString;
     createdDate: z.ZodString;
@@ -22,7 +22,7 @@ export declare const PaymentSessionSchema: z.ZodObject<{
 export declare const PaymentSessionsResponseSchema: z.ZodObject<{
     items: z.ZodArray<z.ZodObject<{
         id: z.ZodNumber;
-        orderId: z.ZodNumber;
+        orderId: z.ZodNullable<z.ZodNumber>;
         amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         status: z.ZodString;
         createdDate: z.ZodString;
@@ -35,12 +35,12 @@ export declare const PaymentSessionsResponseSchema: z.ZodObject<{
     total: z.ZodNumber;
 }, z.core.$strip>;
 /**
- * Single payment session response schema
- * @description Schema for a single payment session or array of sessions by order
+ * Sessions of one order
+ * @description The answer of `/sessions/order/{id}` is always an array (`[]` when there are none)
  */
-export declare const SinglePaymentSessionSchema: z.ZodUnion<readonly [z.ZodObject<{
+export declare const SinglePaymentSessionSchema: z.ZodArray<z.ZodObject<{
     id: z.ZodNumber;
-    orderId: z.ZodNumber;
+    orderId: z.ZodNullable<z.ZodNumber>;
     amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     status: z.ZodString;
     createdDate: z.ZodString;
@@ -49,18 +49,7 @@ export declare const SinglePaymentSessionSchema: z.ZodUnion<readonly [z.ZodObjec
     paymentAccountId: z.ZodNumber;
     paymentUrl: z.ZodNullable<z.ZodString>;
     clientSecret: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>, z.ZodArray<z.ZodObject<{
-    id: z.ZodNumber;
-    orderId: z.ZodNumber;
-    amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    status: z.ZodString;
-    createdDate: z.ZodString;
-    updatedDate: z.ZodString;
-    type: z.ZodString;
-    paymentAccountId: z.ZodNumber;
-    paymentUrl: z.ZodNullable<z.ZodString>;
-    clientSecret: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>>]>;
+}, z.core.$strip>>;
 /**
  * Payment account schema
  * @description Schema for a payment account
@@ -71,7 +60,13 @@ export declare const PaymentAccountSchema: z.ZodObject<{
     isVisible: z.ZodBoolean;
     isUsed: z.ZodBoolean;
     testMode: z.ZodBoolean;
-    type: z.ZodString;
+    type: z.ZodEnum<{
+        custom: "custom";
+        stripe: "stripe";
+        yookassa: "yookassa";
+        midtrans: "midtrans";
+        xendit: "xendit";
+    }>;
     settings: z.ZodRecord<z.ZodString, z.ZodAny>;
     testSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
@@ -86,7 +81,13 @@ export declare const PaymentAccountsResponseSchema: z.ZodArray<z.ZodObject<{
     isVisible: z.ZodBoolean;
     isUsed: z.ZodBoolean;
     testMode: z.ZodBoolean;
-    type: z.ZodString;
+    type: z.ZodEnum<{
+        custom: "custom";
+        stripe: "stripe";
+        yookassa: "yookassa";
+        midtrans: "midtrans";
+        xendit: "xendit";
+    }>;
     settings: z.ZodRecord<z.ZodString, z.ZodAny>;
     testSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;

package/esm/payments/paymentsSchemas.js

@@ -5,7 +5,7 @@ import { z } from 'zod';
  */
 export const PaymentSessionSchema = z.object({
     id: z.number(),
-    orderId: z.number(),
+    orderId: z.number().nullable(),
     amount: z.number().nullable().optional(),
     status: z.string(),
     createdDate: z.string(),
@@ -24,13 +24,10 @@ export const PaymentSessionsResponseSchema = z.object({
     total: z.number(),
 });
 /**
- * Single payment session response schema
- * @description Schema for a single payment session or array of sessions by order
+ * Sessions of one order
+ * @description The answer of `/sessions/order/{id}` is always an array (`[]` when there are none)
  */
-export const SinglePaymentSessionSchema = z.union([
-    PaymentSessionSchema,
-    z.array(PaymentSessionSchema),
-]);
+export const SinglePaymentSessionSchema = z.array(PaymentSessionSchema);
 /**
  * Payment account schema
  * @description Schema for a payment account
@@ -41,7 +38,7 @@ export const PaymentAccountSchema = z.object({
     isVisible: z.boolean(),
     isUsed: z.boolean(),
     testMode: z.boolean(),
-    type: z.string(),
+    type: z.enum(['stripe', 'yookassa', 'midtrans', 'xendit', 'custom']),
     settings: z.record(z.string(), z.any()),
     testSettings: z.record(z.string(), z.any()).optional(),
     localizeInfos: z.record(z.string(), z.any()),

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

@@ -33,7 +33,7 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @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).
+     * @description Search for a product status object by its textual identifier (marker). Despite the name it returns the status itself, not products — to list products with a status, filter `Products.getProducts` by `statusMarker`.
      * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/getProductsByStatusMarker getProductsByStatusMarker} documentation.
      */
     getProductsByStatusMarker(marker: string, langCode?: string): Promise<IProductStatusEntity | IError>;

package/esm/product-statuses/productStatusesApi.js

@@ -26,7 +26,7 @@ export default class ProductStatusesApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/getProductStatuses getProductStatuses} documentation.
      */
     async getProductStatuses(langCode = this.state.lang) {
-        const result = await this._fetchGet('');
+        const result = await this._fetchGet(`?langCode=${encodeURIComponent(langCode)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('ProductStatusesResponseSchema'));
         return this._normalizeData(validated, langCode);
@@ -38,11 +38,11 @@ export default class ProductStatusesApi extends AsyncModules {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @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).
+     * @description Search for a product status object by its textual identifier (marker). Despite the name it returns the status itself, not products — to list products with a status, filter `Products.getProducts` by `statusMarker`.
      * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/getProductsByStatusMarker getProductsByStatusMarker} documentation.
      */
     async getProductsByStatusMarker(marker, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${marker}`);
+        const result = await this._fetchGet(`/marker/${this._pathSegment(marker)}?langCode=${encodeURIComponent(langCode)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('ProductStatusEntitySchema'));
         return this._normalizeData(validated, langCode);
@@ -57,7 +57,7 @@ export default class ProductStatusesApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/validateMarker validateMarker} documentation.
      */
     async validateMarker(marker) {
-        const result = await this._fetchGet(`/marker-validation/${marker}`);
+        const result = await this._fetchGet(`/marker-validation/${this._pathSegment(marker)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('ValidateMarkerResponseSchema'));
         // Extract the 'valid' boolean value from the response object

package/esm/product-statuses/productStatusesInterfaces.d.ts

@@ -41,10 +41,7 @@ interface IProductStatusesApi {
  * @property {ILocalizeInfo} localizeInfos - Localized name of the product status.
  * @example
     {
-      "title": "Catalog",
-      "plainContent": "Content for catalog",
-      "htmlContent": "<b>Content for catalog</b>",
-      "menuTitle": "Catalog"
+      "title": "Sold"
     }
  * @property {boolean} isDefault - Whether this is the default status. Example: true.
  * @property {number} version - Version number of the object; changes with each update. Example: 1.

package/esm/products/productsApi.d.ts

@@ -52,14 +52,14 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
-     * @param {string} [userQuery.signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time. Example: "orders_storage".
+     * @param {string} [userQuery.signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time. Must be an existing orders storage marker of the project, e.g. "my_order"; a marker with no such storage fails the whole request with `404 Specified orders storage for price signature not found`.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {string} [userQuery.sortOrder] - Sorting order parameter.
      * @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.
+     * @description Fetch products with optional filters and pagination. `limit` is an integer from `1` (`0` or `1.5` answer `400`). A `signPrice` naming no orders storage fails the whole request with `404 Specified orders storage for price signature not found`. Products without a translation in `langCode` are left out.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProducts getProducts} documentation.
      */
     getProducts(body?: IFilterParams[], langCode?: string, userQuery?: IProductsQueryBase): Promise<IProductsResponse | IError>;
@@ -75,7 +75,7 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @returns {Promise<IProductsResponse | IError>} Products without a category: `{ items, total }`, the same container as getProducts.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -120,7 +120,7 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -139,7 +139,7 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
           "limit": 30,
           "offset": 0,
           "sortOrder": "DESC",
-          "signPrice": "orders",
+          "signPrice": "my_order",
           "statusMarker": "in_stock"
         }
      * @returns {Promise<IProductsInfo | IError>} Array with ProductInformation objects.
@@ -185,7 +185,7 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -205,7 +205,7 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
           "offset": 0,
           "sortOrder": "DESC",
           "sortKey": "id",
-          "signPrice": "orders",
+          "signPrice": "my_order",
           "statusMarker": "in_stock",
           "templateMarker": "template_12345"
         }
@@ -223,18 +223,18 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
     /**
      * Find products by its ids.
      * @handleName getProductsByIds
-     * @param {string} ids - Comma-separated IDs of the product pages to fetch. Example: "12345,67890".
+     * @param {string} ids - Comma-separated product IDs. Unknown ids are dropped and repeated ones collapsed; a non-numeric one answers `400 Incorrect request`. Example: "12345,67890".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {IProductsByIdsQuery} [userQuery] - Optional query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
-          "signPrice": "orders"
+          "signPrice": "my_order"
         }
      * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
      * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
-     * @param {string} [userQuery.signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
+     * @param {string} [userQuery.signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time. Must be an existing orders storage marker of the project, e.g. "my_order"; a marker with no such storage fails the whole request with `404 Specified orders storage for price signature not found`.
      * @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.
@@ -246,10 +246,10 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
      * @handleName getProductById
      * @param {number} id - Product ID. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {boolean} [isNormalized] - When `true`, the product is returned in normalized form.
+     * @param {boolean} [isNormalized] - Deprecated: the API no longer reads it, the answer is the same with `true`, `false` or without it. Kept for compatibility.
      * @returns {Promise<IProductsEntity | IError>} ProductEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Retrieve one product object.
+     * @description Retrieve one product object. A product with no translation in `langCode` answers `404 Product not found` — there is no fallback to another language.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductById getProductById} documentation.
      */
     getProductById(id: number, langCode?: string, isNormalized?: boolean): Promise<IProductsEntity | IError>;
@@ -257,12 +257,13 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
      * Getting a product block object by product id.
      * @handleName getProductBlockById
      * @param {number} id - Product ID. Example: 12345.
-     * @returns {Promise<IProductBlock | IError>} - Product block object.
+     * @param {string} [langCode] - Language code. Default: the client's language.
+     * @returns {Promise<IProductBlock[] | IError>} - Array of the product's block objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting a product block object by product id.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductBlockById getProductBlockById} documentation.
      */
-    getProductBlockById(id: number): Promise<IProductBlock[] | IError>;
+    getProductBlockById(id: number, langCode?: string): Promise<IProductBlock[] | IError>;
     /**
      * Quick search for product page objects with limited output.
      * @handleName searchProduct
@@ -277,18 +278,13 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
     /**
      * Getting the number of products for the entire catalog.
      * @handleName getProductsCount
-     * @param {any[]} body - Filter objects with search conditions. Default: `[]`.
+     * @param {any[]} [body] - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
             "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
+            "conditionMarker": "eq",
+            "conditionValue": 51
           }
         ]
      * @returns {Promise<IProductsCount | IError>} Object with product items count.
@@ -306,44 +302,16 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
         [
           {
             "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
+            "conditionMarker": "eq",
+            "conditionValue": 51
           }
         ]
      * @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.
+     * @description This method calculates and returns the number of products available on a given catalog page, identified by its page ID, with optional filtering. The counts do not depend on the language: on a language where the catalog is empty they still count every product (CMS-1201).
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsCountByPageId getProductsCountByPageId} documentation.
      */
     getProductsCountByPageId(id: number | string, body?: any[]): Promise<IProductsCount | IError>;
-    /**
-     * Getting the number of products for the catalog page by page url.
-     * @handleName getProductsCountByPageUrl
-     * @param {string} url - Page URL.
-     * @param {any[]} body - Filter objects with search conditions. Default: `[]`.
-     * @example
-        [
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
-          }
-        ]
-     * @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.
-     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsCountByPageUrl getProductsCountByPageUrl} documentation.
-     */
     /**
      * Semantic (vector) search for products.
      * @handleName getProductsByVectorSearch
@@ -358,10 +326,22 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
      */
     getProductsByVectorSearch(body: IVectorSearchProducts, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IProductsResponse> | IError>;
     /**
-     * Get products by page url.
-     * @param {string} url - Page URL.
-     * @param {any[]} body - Request body.
-     * @returns {IProductsEntity[] | IError} Returns an array of products or an error object.
+     * Getting the number of products for the catalog page by page url.
+     * @handleName getProductsCountByPageUrl
+     * @param {string} url - Page URL. Example: "catalog".
+     * @param {any[]} [body] - Filter objects with search conditions. Default: `[]`.
+     * @example
+        [
+          {
+            "attributeMarker": "price",
+            "conditionMarker": "eq",
+            "conditionValue": 51
+          }
+        ]
+     * @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. The counts do not depend on the language: on a language where the catalog is empty they still count every product (CMS-1201).
+     * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsCountByPageUrl getProductsCountByPageUrl} documentation.
      */
     getProductsCountByPageUrl(url: string, body?: any[]): Promise<IProductsCount | IError>;
 }