oneentry 1.0.175 → 1.0.177

package/dist/integration-collections/integrationCollectionsInterfaces.d.ts

@@ -71,11 +71,12 @@ interface ICollectionsApi {
      * @handleName getICollectionRowsByMarker
      * @param {string} marker - Marker of the collection. Example: "collection1".
      * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {ICollectionQuery} [userQuery] - Pagination and entity filter. Without it the API returns the first 30 records only.
      * @returns {ICollectionRowsResponce} Returns collection row entity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method gets all records from the collection.
+     * @description Records of the collection, one page at a time: `limit` defaults to 30 and `total` holds the full count.
      */
-    getICollectionRowsByMarker(marker: string, langCode?: string): Promise<ICollectionRowsResponce | IError>;
+    getICollectionRowsByMarker(marker: string, langCode?: string, userQuery?: ICollectionQuery): Promise<ICollectionRowsResponce | IError>;
     /**
      * Getting one record from the collection.
      * @handleName getICollectionRowByMarkerAndId
@@ -189,13 +190,13 @@ interface ICollectionResponce {
  * @interface ICollectionFormData
  * @property {string} marker - Text identifier (marker) of the form field. Example: "collection_marker".
  * @property {string} type - Type of the form field, for example `"text"`, `"number"` or `"date"`. Example: "number".
- * @property {string} value - Value of the form field. Example: "Collection marker".
+ * @property {string | number | null} value - Value of the form field. Send a string; on reading, `integer`/`float`/`real` fields come back as a `number` — and as `null` when the stored value is not a number (the API stores `"abc"` in a `float` field as is, the SDK does not pass it on). Example: "Collection marker".
  * @description Represents a form data object within a collection, containing a marker, type, and value.
  */
 interface ICollectionFormData {
     marker: string;
     type: string;
-    value: string;
+    value: string | number | null;
 }
 /**
  * Collection form object
@@ -225,7 +226,7 @@ interface ICollectionFormObject {
  * @property {number} id - Object ID. Example: 1.
  * @property {string} createdDate - Creation date of the record. Example: "2023-01-01T00:00:00Z".
  * @property {string} updatedDate - Date the record was last updated. Example: "2023-01-02T00:00:00Z".
- * @property {number | null} [collectionId] - ID of the collection the row belongs to. Example: "product", "order", "etc".
+ * @property {number | null} [collectionId] - ID of the collection the row belongs to. The row list and row-by-id endpoints do not return it. Example: 1.
  * @property {ICollectionFormData[]} formData - Form fields of the collection row.
  * @example
     [
@@ -240,8 +241,7 @@ interface ICollectionFormObject {
  * @property {string | null} [attributeSetIdentifier] - Marker of the attribute set used by the form attached to the collection row, or `null` if there is none. Example: "attributeSet1" or null.
  * @property {string | null} [langCode] - Language code the row was stored under. Example: "en_US".
  * @property {string | null} [formIdentifier] - Marker of the form the row was created from; returned by the create and update row endpoints. Example: "collection_form".
- * @property {string} total - Total number of records. Example: "1".
- * @description Represents a row in a collection, containing various properties such as identifiers, dates, form data, and an optional total value.
+ * @description Represents a row in a collection, containing various properties such as identifiers, dates and form data.
  */
 interface ICollectionRow {
     id: number;
@@ -254,7 +254,6 @@ interface ICollectionRow {
     attributeSetIdentifier?: string | null;
     langCode?: string | null;
     formIdentifier?: string | null;
-    total?: string;
 }
 /**
  * Collection rows response object
@@ -315,4 +314,4 @@ interface ICollectionQuery {
  * @property {number} [offset] - Number of records to skip. Default: 0.
  */
 type ICollectionsListQuery = Pick<ICollectionQuery, 'limit' | 'offset'>;
-export type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionResponce, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, ICollectionsListQuery, };
+export type { ICollectionEntity, ICollectionFormData, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionResponce, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, ICollectionsListQuery, };

package/dist/integration-collections/integrationCollectionsSchemas.d.ts

@@ -51,7 +51,6 @@ export declare const CollectionRowSchema: z.ZodObject<{
     attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     langCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     formIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    total: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 /**
  * Collection rows response schema
@@ -72,7 +71,6 @@ export declare const CollectionRowsResponseSchema: z.ZodObject<{
         attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         langCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         formIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        total: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
     total: z.ZodNumber;
 }, z.core.$strip>;

package/dist/integration-collections/integrationCollectionsSchemas.js

@@ -46,7 +46,6 @@ exports.CollectionRowSchema = zod_1.z.object({
     attributeSetIdentifier: zod_1.z.string().nullable().optional(),
     langCode: zod_1.z.string().nullable().optional(),
     formIdentifier: zod_1.z.string().nullable().optional(),
-    total: zod_1.z.string().optional(),
 });
 /**
  * Collection rows response schema

package/dist/menus/menusApi.js

@@ -65,7 +65,7 @@ class MenusApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/menus/getMenusByMarker getMenusByMarker} documentation.
      */
     async getMenusByMarker(marker, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        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('MenuEntitySchema'));
         return this._normalizeData(validated, langCode);

package/dist/orders/ordersApi.d.ts

@@ -165,6 +165,7 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IOrderStatus[] | IError>} Returns an object with the orders statuses.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get all order statuses of the storage. This method requires user authorization: a guest gets `401 Unauthorized`.
      * @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}.
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllStatusesByStorageMarker getAllStatusesByStorageMarker} documentation.
      */
@@ -211,19 +212,6 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrdersByVectorSearch getOrdersByVectorSearch} documentation.
      */
     getOrdersByVectorSearch(body: IOrdersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IOrdersByMarkerEntity> | IError>;
-    /**
-     * Runs a fetch against the `/orders` base URL instead of the default
-     * `/orders-storage`, then restores the original URL.
-     *
-     * Refund endpoints live under `/api/content/orders`, while this class is based
-     * on `/api/content/orders-storage`. The helper swaps `_url` for the duration of
-     * the call and restores it in `finally`, so the base URL is restored even if
-     * the request throws.
-     * @param {() => Promise<T>} fetcher - Thunk performing the fetch call.
-     * @returns {Promise<T>} The fetcher result.
-     * @template T
-     */
-    private _withOrdersUrl;
     /**
      * Builds the order body the API expects: `formData` wrapped in a map keyed by locale.
      *

package/dist/orders/ordersApi.js

@@ -69,8 +69,8 @@ class OrdersApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllOrdersStorage getAllOrdersStorage} documentation.
      */
     async getAllOrdersStorage(langCode = this.state.lang, offset = 0, limit = 30) {
-        const result = await this._fetchGet(`?langCode=${langCode}&limit=${limit}&offset=${offset}`);
-        return this._normalizeData(result);
+        const result = await this._fetchGet(`?langCode=${encodeURIComponent(langCode)}&limit=${encodeURIComponent(String(limit))}&offset=${encodeURIComponent(String(offset))}`);
+        return this._normalizeData(result, langCode);
     }
     /**
      * Getting all orders from the orders storage object created by the user.
@@ -86,10 +86,10 @@ class OrdersApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllOrdersByMarker getAllOrdersByMarker} documentation.
      */
     async getAllOrdersByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
-        const result = await this._fetchGet(`/marker/${marker}/orders?langCode=${langCode}&limit=${limit}&offset=${offset}`);
+        const result = await this._fetchGet(`/marker/${this._pathSegment(marker)}/orders?langCode=${encodeURIComponent(langCode)}&limit=${encodeURIComponent(String(limit))}&offset=${encodeURIComponent(String(offset))}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('OrdersResponseSchema'));
-        return this._normalizeData(validated);
+        return this._normalizeData(validated, langCode);
     }
     /**
      * Retrieve one order storage object by marker.
@@ -103,8 +103,8 @@ class OrdersApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrdersStorageByMarker getOrdersStorageByMarker} documentation.
      */
     async getOrdersStorageByMarker(marker, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
-        return this._normalizeData(result);
+        const result = await this._fetchGet(`/marker/${this._pathSegment(marker)}?langCode=${encodeURIComponent(langCode)}`);
+        return this._normalizeData(result, langCode);
     }
     /**
      * Getting a single order from the order storage object created by the user.
@@ -119,10 +119,10 @@ class OrdersApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrderByMarkerAndId getOrderByMarkerAndId} documentation.
      */
     async getOrderByMarkerAndId(marker, id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${marker}/orders/${id}?langCode=${langCode}`);
+        const result = await this._fetchGet(`/marker/${this._pathSegment(marker)}/orders/${this._pathSegment(String(id))}?langCode=${encodeURIComponent(langCode)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('OrderEntitySchema'));
-        return this._normalizeData(validated);
+        return this._normalizeData(validated, langCode);
     }
     /**
      * Getting a single order created by the user, by its own id.
@@ -138,10 +138,10 @@ class OrdersApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrderById getOrderById} documentation.
      */
     async getOrderById(id, langCode = this.state.lang) {
-        const result = await this._withOrdersUrl(() => this._fetchGet(`/${id}?langCode=${langCode}`));
+        const result = await this._withBaseUrl(this._ordersUrl)._fetchGet(`/${this._pathSegment(String(id))}?langCode=${encodeURIComponent(langCode)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('OrderEntitySchema'));
-        return this._normalizeData(validated);
+        return this._normalizeData(validated, langCode);
     }
     /**
      * Preview order calculation with discounts and coupons (without saving).
@@ -155,8 +155,8 @@ class OrdersApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/previewOrder previewOrder} documentation.
      */
     async previewOrder(body, langCode = this.state.lang) {
-        const result = await this._fetchPost(`/orders/preview?langCode=${langCode}`, body);
-        return this._normalizeData(result);
+        const result = await this._fetchPost(`/orders/preview?langCode=${encodeURIComponent(langCode)}`, body);
+        return this._normalizeData(result, langCode);
     }
     /**
      * Creation of an order in the order storage.
@@ -187,10 +187,10 @@ class OrdersApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/createOrder createOrder} documentation.
      */
     async createOrder(marker, body, langCode = this.state.lang) {
-        const result = await this._fetchPost(`/marker/${marker}/orders`, this._wrapOrderFormData(body, langCode));
+        const result = await this._fetchPost(`/marker/${this._pathSegment(marker)}/orders`, this._wrapOrderFormData(body, langCode));
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('CreateOrderResponseSchema'));
-        return this._normalizeData(validated);
+        return this._normalizeData(validated, langCode);
     }
     /**
      * Changing an order in the orders storage
@@ -223,10 +223,10 @@ class OrdersApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/updateOrderByMarkerAndId updateOrderByMarkerAndId} documentation.
      */
     async updateOrderByMarkerAndId(marker, id, body, langCode = this.state.lang) {
-        const result = await this._fetchPut(`/marker/${marker}/orders/${id}?langCode=${langCode}`, this._wrapOrderFormData(body, langCode));
+        const result = await this._fetchPut(`/marker/${this._pathSegment(marker)}/orders/${this._pathSegment(String(id))}?langCode=${encodeURIComponent(langCode)}`, this._wrapOrderFormData(body, langCode));
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('UpdateOrderResponseSchema'));
-        return this._normalizeData(validated);
+        return this._normalizeData(validated, langCode);
     }
     /**
      * Get all orders statuses by Storage marker
@@ -237,6 +237,7 @@ class OrdersApi extends asyncModules_1.default {
      * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IOrderStatus[] | IError>} Returns an object with the orders statuses.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get all order statuses of the storage. This method requires user authorization: a guest gets `401 Unauthorized`.
      * @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}.
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllStatusesByStorageMarker getAllStatusesByStorageMarker} documentation.
      */
@@ -246,8 +247,9 @@ class OrdersApi extends asyncModules_1.default {
             offset,
             limit,
         };
-        const data = await this._fetchGet(`/marker/${marker}/order-statuses?` + this._queryParamsToString(query));
-        return this._normalizeData(data);
+        const data = await this._fetchGet(`/marker/${this._pathSegment(marker)}/order-statuses?` +
+            this._queryParamsToString(query));
+        return this._normalizeData(data, langCode);
     }
     /**
      * Get all refund requests for an order.
@@ -258,7 +260,7 @@ class OrdersApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getRefunds getRefunds} documentation.
      */
     async getRefunds(id) {
-        const data = await this._withOrdersUrl(() => this._fetchGet(`/${id}/refund`));
+        const data = await this._withBaseUrl(this._ordersUrl)._fetchGet(`/${this._pathSegment(String(id))}/refund`);
         return this._normalizeData(data);
     }
     /**
@@ -271,7 +273,7 @@ class OrdersApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/createRefundRequest createRefundRequest} documentation.
      */
     async createRefundRequest(id, body) {
-        const data = await this._withOrdersUrl(() => this._fetchPost(`/${id}/refund`, body));
+        const data = await this._withBaseUrl(this._ordersUrl)._fetchPost(`/${this._pathSegment(String(id))}/refund`, body);
         return this._normalizeData(data);
     }
     /**
@@ -283,7 +285,7 @@ class OrdersApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/cancelRefundRequest cancelRefundRequest} documentation.
      */
     async cancelRefundRequest(id) {
-        const data = await this._withOrdersUrl(() => this._fetchDelete(`/${id}/refund`));
+        const data = await this._withBaseUrl(this._ordersUrl)._fetchDelete(`/${this._pathSegment(String(id))}/refund`);
         return this._normalizeData(data);
     }
     /**
@@ -305,31 +307,9 @@ class OrdersApi extends asyncModules_1.default {
             offset,
             limit,
         };
-        const data = await this._withOrdersUrl(() => this._fetchPost(`/vector/search?` + this._queryParamsToString(query), body));
+        const data = await this._withBaseUrl(this._ordersUrl)._fetchPost(`/vector/search?` + this._queryParamsToString(query), body);
         return this._normalizeData(data, langCode);
     }
-    /**
-     * Runs a fetch against the `/orders` base URL instead of the default
-     * `/orders-storage`, then restores the original URL.
-     *
-     * Refund endpoints live under `/api/content/orders`, while this class is based
-     * on `/api/content/orders-storage`. The helper swaps `_url` for the duration of
-     * the call and restores it in `finally`, so the base URL is restored even if
-     * the request throws.
-     * @param {() => Promise<T>} fetcher - Thunk performing the fetch call.
-     * @returns {Promise<T>} The fetcher result.
-     * @template T
-     */
-    async _withOrdersUrl(fetcher) {
-        const savedUrl = this._url;
-        this._url = this._ordersUrl;
-        try {
-            return await fetcher();
-        }
-        finally {
-            this._url = savedUrl;
-        }
-    }
     /**
      * Builds the order body the API expects: `formData` wrapped in a map keyed by locale.
      *

package/dist/orders/ordersInterfaces.d.ts

@@ -141,6 +141,7 @@ interface IOrdersApi {
      * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IOrderStatus[] | IError>} Returns an object with the orders statuses.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get all order statuses of the storage. This method requires user authorization: a guest gets `401 Unauthorized`.
      * @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}.
      */
     getAllStatusesByStorageMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrderStatus[] | IError>;
@@ -216,7 +217,8 @@ interface IOrdersVectorSearch {
           }
         ],
         "attributeSetIdentifier": "order_form",
-        "totalSum": "300.00",
+        "totalSum": "300",
+        "totalSumRaw": "300",
         "currency": "",
         "paymentAccountIdentifier": "cash",
         "paymentAccountLocalizeInfos": {
@@ -227,9 +229,10 @@ interface IOrdersVectorSearch {
           "id": 2957,
           "title": "Cosmo",
           "sku": null,
-          "previewImage": null,
+          "previewImage": [],
           "price": 150,
-          "quantity": 2
+          "quantity": 2,
+          "isGift": false
           }
         ],
         "isCompleted": false
@@ -262,9 +265,9 @@ interface IPicture {
  * @interface IOrderProducts
  * @property {number} id - Product ID. Example: 2957.
  * @property {number} quantity - Product quantity. Example: 1.
- * @property {string} title - Product title. Example: "Cosmo".
+ * @property {string | null} title - Product title; `null` on a language the product has no translation in. Example: "Cosmo".
  * @property {string | null} sku - Product SKU. Example: "SKU".
- * @property {IPicture | null} previewImage - Preview image of the product.
+ * @property {IPicture | IPicture[] | null} previewImage - Preview image of the product. A product without one comes as an empty array `[]`, not `null` — check `Array.isArray(previewImage) ? previewImage[0] : previewImage`.
  * @example
     {
       "filename": "image.jpg",
@@ -279,9 +282,9 @@ interface IPicture {
 interface IOrderProducts {
     id: number;
     quantity: number;
-    title: string;
+    title: string | null;
     sku: string | null;
-    previewImage: IPicture | null;
+    previewImage: IPicture | IPicture[] | null;
     price: number;
     isGift: boolean;
 }
@@ -542,7 +545,7 @@ interface IOrderData {
  * @property {number} productId - Identifier of the product covered by the stage. Example: 1.
  * @property {string} title - Stage title. Example: "Deposit".
  * @property {number} value - Stage amount. Example: 100.
- * @property {string} status - Stage status. Example: "pending".
+ * @property {string} status - Stage status. Example: "planned".
  * @description A single stage of a split (staged) order payment.
  */
 interface IOrderSplitStage {
@@ -583,8 +586,8 @@ interface IOrderSplit {
       }
     ]
  * @property {string | null} [attributeSetIdentifier] - Marker of the attribute set. Example: "attribute-set-1".
- * @property {string} totalSum - Total order amount. Example: "100.00".
- * @property {string} [totalSumRaw] - Raw total order amount with full precision. Example: "100.00".
+ * @property {string} totalSum - Total order amount. Example: "300".
+ * @property {string} [totalSumRaw] - Raw total order amount with full precision. Example: "300".
  * @property {string} currency - Currency used to pay for the order. Example: "USD".
  * @property {string | null} [paymentAccountIdentifier] - Marker of the payment account. Example: "payment-1".
  * @property {ILocalizeInfo} [paymentAccountLocalizeInfos] - Localized name of the payment account.
@@ -596,9 +599,13 @@ interface IOrderSplit {
  * @example
     [
       {
-        "id": 1,
-        "name": "Product 1",
-        "quantity": 2
+        "id": 2957,
+        "title": "Cosmo",
+        "sku": null,
+        "previewImage": [],
+        "price": 150,
+        "quantity": 2,
+        "isGift": false
       }
     ]
  * @property {string | null} paymentUrl - Payment page URL. Example: "https://example.com/pay/123".
@@ -773,4 +780,4 @@ interface ICreateRefundRequest {
     products: Record<string, IRefundProduct>;
     note?: string;
 }
-export type { IBaseOrdersEntity, IBaseOrdersEntityResponse, ICreateOrderPreview, ICreateRefundRequest, IOrderByMarkerEntity, IOrderData, IOrderDiscountBonus, IOrderDiscountConfig, IOrderDiscountSettings, IOrderPreviewItem, IOrderPreviewResponse, IOrderProductData, IOrderProducts, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity, IOrdersFormData, IOrderSplit, IOrderSplitStage, IOrderStatus, IOrdersVectorSearch, IPaymentAccountIdentifiers, IPicture, IPreviewOrderProduct, IRefundProduct, IRefundRequest, };
+export type { IBaseOrdersEntity, IBaseOrdersEntityResponse, ICreateOrderPreview, ICreateRefundRequest, IOrderByMarkerEntity, IOrderData, IOrderDiscountBonus, IOrderDiscountConfig, IOrderDiscountSettings, IOrderPreviewItem, IOrderPreviewResponse, IOrderProductData, IOrderProducts, IOrderProductsData, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity, IOrdersFormData, IOrderSplit, IOrderSplitStage, IOrderStatus, IOrdersVectorSearch, IPaymentAccountIdentifiers, IPicture, IPreviewOrderProduct, IRefundProduct, IRefundRequest, };

package/dist/pages/pagesApi.d.ts

@@ -61,9 +61,9 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
     /**
      * Get child pages object with information as an array.
      * @handleName getChildPagesByParentUrl
-     * @param {string} url - URL of the parent page whose child pages to fetch. Example: "about/our-team".
+     * @param {string} url - URL of the parent page whose child pages to fetch — the page's own `pageUrl`, not a nested path: `blog/blog1` answers `404`. Example: "blog".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IPagesEntity | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
+     * @returns {Promise<IPagesEntity[] | IError>} Returns an array of PageEntity objects for the selected parent, or an empty array [] when it has no child pages. A parent page that does not exist answers `404 Parent page not found` (IError).
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get child pages object with information as an array.
      * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getChildPagesByParentUrl getChildPagesByParentUrl} documentation.
@@ -109,6 +109,7 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
      * Add template data to pages
      * @handleName addTemplateToPages
      * @param {IPagesEntity[]} data - An array of page objects (IPagesEntity[]) to which template data will be added.
+     * @param {string} [langCode] - Language the templates are fetched and unwrapped in. Default: the client's language.
      * @example
         [
           {
@@ -149,15 +150,15 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
      * @description Add template data to pages. Optimized to avoid N+1 query problem by fetching only unique templates in parallel.
      * For example, if 100 pages use 3 different templates, this method makes 3 requests instead of 100.
      */
-    protected addTemplateToPages(data: IPagesEntity[]): Promise<any | IError>;
+    protected addTemplateToPages(data: IPagesEntity[], langCode?: string): Promise<any | IError>;
     /**
      * Add template data to page by page templateIdentifier
      * @handleName addTemplateToPage
      * @param {IPagesEntity} data - Page object (IPagesEntity) to which template data will be added.
+     * @param {string} [langCode] - Language the templates are fetched and unwrapped in. Default: the client's language.
      * @returns {Promise<any | IError>} An array of page objects with template data added
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Add template data to page by page templateIdentifier
-     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/addTemplateToPage addTemplateToPage} documentation.
      */
-    protected addTemplateToPage(data: IPagesEntity): Promise<any | IError>;
+    protected addTemplateToPage(data: IPagesEntity, langCode?: string): Promise<any | IError>;
 }