oneentry 1.0.63 → 1.0.64

package/dist/blocks/blocksApi.d.ts

@@ -1,5 +1,5 @@
 import OneEntry from "../base/oneEntry";
-import { IBlocks, IBlocksResponse, IBlockEntity } from "./blocksInterfaces";
+import { IBlocks, IBlocksResponse, IBlockEntity, ISearchBlock } from "./blocksInterfaces";
 import { IProductsEntity } from "../products/productsInterfaces";
 import { IConfig } from "../base/utils";
 /**
@@ -48,4 +48,10 @@ export default class BlocksApi extends OneEntry implements IBlocks {
      * @returns Return array of BlocksEntity object.
      */
     getProductsByBlockMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IProductsEntity>>;
+    /**
+     * Quick search for block objects with limited output
+     * @param name - Search string
+     * @param [langCode] - Language code. Default "en_US"
+     */
+    searchBlock(name: string, langCode?: string): Promise<Array<ISearchBlock>>;
 }

package/dist/blocks/blocksApi.js

@@ -131,5 +131,14 @@ class BlocksApi extends oneEntry_1.default {
         const result = await this._fetchGet(`/${marker}/products?langCode=${langCode}&offset=${offset}&limit=${limit}`);
         return this._normalizeData(result.items);
     }
+    /**
+     * Quick search for block objects with limited output
+     * @param name - Search string
+     * @param [langCode] - Language code. Default "en_US"
+     */
+    async searchBlock(name, langCode = this._defaultLangCode) {
+        const result = await this._fetchGet(`/quick/search?langCode=${langCode}&name=${name}`);
+        return result;
+    }
 }
 exports.default = BlocksApi;

package/dist/blocks/blocksInterfaces.d.ts

@@ -6,12 +6,14 @@ import { IProductsEntity } from "../products/productsInterfaces";
  * @property {function} getBlockByMarker - Get Block object by marker.
  * @property {function} getSimilarProducts - Get Array of similar products from product-similar block.
  * @property {function} getProductsByBlockMarker - Get Array of products from product block.
+ * @property {function} searchBlock - Quick search for block objects with limited output.
  */
 interface IBlocks {
     getBlocks(langCode: string, offset?: number, limit?: number): Promise<Array<IBlockEntity | IBlocksResponse>>;
     getBlockByMarker(marker: string, langCode: string): Promise<IBlockEntity>;
     getSimilarProducts(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IProductsEntity>>;
     getProductsByBlockMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IProductsEntity>>;
+    searchBlock(name: string, langCode?: string): Promise<Array<ISearchBlock>>;
 }
 interface IBlocksResponse {
     id: number;
@@ -59,4 +61,9 @@ interface ICustomSetting {
     }> | Record<string, any>;
     [key: string]: any;
 }
-export { IBlocks, IBlockEntity, IBlocksResponse, ICustomSetting };
+interface ISearchBlock {
+    id: number;
+    name: string;
+    identifier: string;
+}
+export { IBlocks, IBlockEntity, IBlocksResponse, ICustomSetting, ISearchBlock };

package/dist/formsData/formsDataInterfaces.d.ts

@@ -2,9 +2,7 @@
  * Represents a interface object of Forms Api.
  *
  * @property {function} getFormsData - Get all forms data.
- *
  * @property {function} postFormsData - Find all product page objects with pagination and multiple filtering.
- *
  * @property {function} getFormsDataByMarker - Get one object of form data by marker.
  */
 interface IFormsData {
@@ -52,7 +50,7 @@ interface IFormsPost {
     id?: number;
     formIdentifier: string;
     time?: Date | string;
-    formData: Array<IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeText | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | IBodyTypeRadioButtonList>;
+    formData: Array<IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeText | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | IBodyTypeRadioButtonList | Record<string, any>>;
 }
 /**
  * @property {string} marker - marker name

package/dist/orders/ordersApi.d.ts

@@ -1,20 +1,11 @@
 import OneEntry from "../base/oneEntry";
 import { IConfig } from "../base/utils";
-import { IOrdersApi, IOrdersEntity, IBaseOrdersEntity, IOrderData } from "./ordersInterfaces";
+import { IOrdersApi, IOrdersEntity, IBaseOrdersEntity, IOrderData, IOrdersByMarkersEntity } from "./ordersInterfaces";
 /**
  * Controllers for working with orders
  */
 export default class OrdersApi extends OneEntry implements IOrdersApi {
     constructor(url: string, config: IConfig);
-    /**
-     * Retrieve one order storage object by marker.
-     *
-     * @param {string} marker - Marker of the order object
-     * @param {string} [langCode] - Language code
-     *
-     * @returns Return object of order information.
-     */
-    getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity>;
     /**
      * Creation of an order in the order storage.
      *
@@ -43,4 +34,52 @@ export default class OrdersApi extends OneEntry implements IOrdersApi {
      * @returns Returns object for creating an order.
      */
     createOrder(marker: string, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity>;
+    /**
+     * Getting all order storage object by marker
+     * @param {number} marker - Textual identifier of the order storage object
+     * @param {number} [langCode] Optional language field
+     */
+    getAllOrdersByMarker(marker: string, langCode?: string): Promise<Array<IOrdersByMarkersEntity>>;
+    /**
+     * Changing an order in the order store
+     * @param marker - The text identifier of the order storage object
+     * @param id - ID of the order object
+     * @param data Object for updating an order
+     * @param langCode Optional language field
+     *
+     * @example
+     * const body = {
+     *   "formIdentifier": "bar-orders-form",
+     *   "paymentIdentifier": "usd-payment",
+     *   "formData": {
+     *       "marker": "name_1",
+     *       "value": "Name"
+     *   },
+     *   "products": [
+     *     {
+     *       "productId": 1,
+     *       "quantity": 2,
+     *       "price": "23.02"
+     *     }
+     *   ],
+     *   "currency": "USD"
+     * }
+     */
+    updateOrderByMarkerAndId(marker: string, id: string, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity>;
+    /**
+     * Getting all the order storage objects
+     * @param {number} [langCode] Optional language field
+     * @param {number} [limit] - Optional parameter for pagination, default is 0
+     * @param {number} [offset] - Optional parameter for pagination, default is 30
+     */
+    getAllOrders(langCode?: string, limit?: number, offset?: number): Promise<Array<IOrdersEntity>>;
+    /**
+     * Retrieve one order storage object by marker.
+     *
+     * @param {string} marker - Marker of the order object
+     * @param {string} [langCode] - Language code
+     *
+     * @returns Return object of order information.
+     */
+    getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity>;
 }

package/dist/orders/ordersApi.js

@@ -9,18 +9,6 @@ class OrdersApi extends oneEntry_1.default {
         super(url, config);
         this._url += '/api/content/orders-storage';
     }
-    /**
-     * Retrieve one order storage object by marker.
-     *
-     * @param {string} marker - Marker of the order object
-     * @param {string} [langCode] - Language code
-     *
-     * @returns Return object of order information.
-     */
-    async getOrderByMarker(marker, langCode = this._defaultLangCode) {
-        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
-        return this._normalizeData(result);
-    }
     /**
      * Creation of an order in the order storage.
      *
@@ -52,7 +40,67 @@ class OrdersApi extends oneEntry_1.default {
         const formData = {};
         formData[langCode] = Array.isArray(data.formData) ? data.formData : [data.formData];
         data.formData = formData;
-        const result = await this._fetchPost(`/marker/${marker}/order`, data);
+        const result = await this._fetchPost(`/marker/${marker}/orders`, data);
+        return this._normalizeData(result);
+    }
+    /**
+     * Getting all order storage object by marker
+     * @param {number} marker - Textual identifier of the order storage object
+     * @param {number} [langCode] Optional language field
+     */
+    async getAllOrdersByMarker(marker, langCode = this._defaultLangCode) {
+        const result = this._fetchGet(`/marker/${marker}/orders?langCode=${langCode}`);
+        return this._normalizeData(result.items);
+    }
+    /**
+     * Changing an order in the order store
+     * @param marker - The text identifier of the order storage object
+     * @param id - ID of the order object
+     * @param data Object for updating an order
+     * @param langCode Optional language field
+     *
+     * @example
+     * const body = {
+     *   "formIdentifier": "bar-orders-form",
+     *   "paymentIdentifier": "usd-payment",
+     *   "formData": {
+     *       "marker": "name_1",
+     *       "value": "Name"
+     *   },
+     *   "products": [
+     *     {
+     *       "productId": 1,
+     *       "quantity": 2,
+     *       "price": "23.02"
+     *     }
+     *   ],
+     *   "currency": "USD"
+     * }
+     */
+    async updateOrderByMarkerAndId(marker, id, data, langCode = this._defaultLangCode) {
+        const result = await this._fetchPut(`/marker/${marker}/orders/${id}?langCode=${langCode}`, data);
+        return this._normalizeData(result);
+    }
+    /**
+     * Getting all the order storage objects
+     * @param {number} [langCode] Optional language field
+     * @param {number} [limit] - Optional parameter for pagination, default is 0
+     * @param {number} [offset] - Optional parameter for pagination, default is 30
+     */
+    async getAllOrders(langCode = this._defaultLangCode, limit = 30, offset = 0) {
+        const result = await this._fetchGet(`?langCode=${langCode}&limit=${limit}&offset=${offset}`);
+        return this._normalizeData(result);
+    }
+    /**
+     * Retrieve one order storage object by marker.
+     *
+     * @param {string} marker - Marker of the order object
+     * @param {string} [langCode] - Language code
+     *
+     * @returns Return object of order information.
+     */
+    async getOrderByMarker(marker, langCode = this._defaultLangCode) {
+        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
         return this._normalizeData(result);
     }
 }

package/dist/orders/ordersInterfaces.d.ts

@@ -3,11 +3,17 @@
  *
  * @property {function} getOrderByMarker - Retrieve one order storage object by marker.
  * @property {function} createOrder - Creation of an order in the order storage.
+ * @property {function} updateOrderByMarkerAndId - Changing an order in the order store.
+ * @property {function} getAllOrders - Getting all the order storage objects.
+ * @property {function} getAllOrdersByMarker - Getting one order storage object by marker.
 
  */
 interface IOrdersApi {
     getOrderByMarker(marker: string, langCode?: string): Promise<IOrdersEntity>;
     createOrder(marker: string, data: IOrderData): Promise<IBaseOrdersEntity>;
+    updateOrderByMarkerAndId(marker: string, id: string, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity>;
+    getAllOrders(langCode?: string, limit?: number, offset?: number): Promise<Array<IOrdersEntity>>;
+    getAllOrdersByMarker(marker: string, langCode?: string): Promise<Array<IOrdersByMarkersEntity>>;
 }
 interface IPicture {
     filename: string;
@@ -105,4 +111,33 @@ interface IOrderData {
     products: Array<IOrderProductData>;
     currency: string;
 }
-export { IOrdersEntity, IBaseOrdersEntity, IOrderProducts, IPicture, IOrdersApi, IOrderData, IOrderProductData, IOrderMarkerData, IOrdersFormData };
+/**
+ * @interface
+ * @property {string} statusIdentifier - Text identifier of the order status.
+ * @property {string} formIdentifier - Text identifier of the form status.
+ * @property {string} paymentIdentifier - Text identifier of the order payment.
+ * @property {Array<IOrdersFormData>} formData - Data submitted by the form linked to the order store.
+ * @property {Array<IOrderProducts>} products - Array of products added to order.
+ * @property {string} totalSum - Total order amount.
+ * @property {number} price - Price order.
+ * @property {string} currency - Currency used to pay for the order.
+ * @property {string} createdDate - Date when the order was created.
+ * @property {string} paymentAccountIdentifier - Textual identifier for the order payment.
+ * @property {Record<string, any>} paymentAccountLocalizeInfos - Payment account name considering localization.
+ * @property {boolean} isHistory - Indicates that the order has been saved in the order history.
+ */
+interface IOrdersByMarkersEntity {
+    statusIdentifier: string;
+    formIdentifier: string;
+    paymentIdentifier: string;
+    formData: Array<IOrdersFormData>;
+    products: Array<IOrderProducts>;
+    totalSum: string;
+    currency: string;
+    createdDate: string;
+    price: number;
+    paymentAccountIdentifier: string;
+    paymentAccountLocalizeInfos: Record<string, any>;
+    isHistory: boolean;
+}
+export { IOrdersEntity, IBaseOrdersEntity, IOrderProducts, IPicture, IOrdersApi, IOrderData, IOrderProductData, IOrderMarkerData, IOrdersFormData, IOrdersByMarkersEntity };

package/dist/products/productsInterfaces.d.ts

@@ -93,6 +93,7 @@ interface IFilterParams {
  *
  * @interface
  * @property {number} id - The unique identifier.
+ * @property {object} additional - Additional value from the index.
  * @property {Record<string, any>} localizeInfos - The name of the products, taking into account localization.
  * @property {boolean} isVisible - A sign of page visibility.
  * @property {number | null} statusId - Product page status identifiers (may be null).
@@ -102,10 +103,17 @@ interface IFilterParams {
  * @property {number} price - The value of the product page price taken from the index.
  * @property {string} templateIdentifier - User id of the linked template.
  * @property {string} shortDescTemplateIdentifier - User id of the linked template for a short description.
+ * @property {Record<string, any>} statusLocalizeInfos - JSON description of the item status object, taking into account the language.
  * @property {number} position - Item number (for sorting).
  */
 interface IProductsEntity {
     id: number;
+    additional: {
+        prices: {
+            min: number;
+            max: number;
+        };
+    };
     localizeInfos: Record<string, any>;
     blocks?: string | Array<string>;
     isVisible: boolean;
@@ -116,6 +124,7 @@ interface IProductsEntity {
     price: number;
     templateIdentifier: string | null;
     shortDescTemplateIdentifier: string;
+    statusLocalizeInfos: Record<string, any>;
     attributeValues: Record<string, any>;
     position: number;
     sku: string | null;

package/dist/templates/templatesApi.d.ts

@@ -22,4 +22,12 @@ export default class TemplatesPreviewApi extends OneEntry implements ITemplatesA
      * @returns Returns a TemplateEntity object
      */
     getTemplateByType(type: Types, langCode?: string): Promise<Array<ITemplateEntity>>;
+    /**
+     * Get one template object by id.
+     *
+     * @param {string} id - Template id
+     *
+     * @returns Returns a TemplateEntity object
+     */
+    getTemplateById(id: string): Promise<ITemplateList>;
 }

package/dist/templates/templatesApi.js

@@ -35,5 +35,16 @@ class TemplatesPreviewApi extends oneEntry_1.default {
         const result = await this._fetchGet(`?type=${type}`);
         return this._normalizeData(result, langCode);
     }
+    /**
+     * Get one template object by id.
+     *
+     * @param {string} id - Template id
+     *
+     * @returns Returns a TemplateEntity object
+     */
+    async getTemplateById(id) {
+        const result = await this._fetchGet(`/${id}`);
+        return result;
+    }
 }
 exports.default = TemplatesPreviewApi;

package/dist/templates/templatesInterfaces.d.ts

@@ -4,12 +4,13 @@ import { Types } from "../base/utils";
  * Represents an interface object of Templates Api.
  *
  * @property {function} getAllTemplates - Get all template objects grouped by types.
- *
  * @property {function} getTemplateByType - Get template objects by type.
+ * @property {function} getTemplateById - Get one template object by id.
  */
 interface ITemplatesApi {
     getAllTemplates(langCode: string): Promise<ITemplateList>;
     getTemplateByType(type: Types, langCode: string): Promise<Array<ITemplateEntity>>;
+    getTemplateById(id: string): Promise<ITemplateList>;
 }
 /**
  * Represents a template entity object.
@@ -21,7 +22,7 @@ interface ITemplatesApi {
  * @property {string} identifier - The textual identifier for the record field.
  * @property {IGeneralTypesEntity} generalType - General type Entity object.
  * @property {number} generalTypeId - General type Entity id.
- * @property {Record<string, any>} localizeInfos - The name of the template, taking into account localization.
+ * @property {string} title - The name of the template.
  * @property {number} position - The position of the object.
  * @property {number | string} positionId - Id of the item object.
  * @property {Types} generalTypeName - General type name.
@@ -34,7 +35,7 @@ interface ITemplateEntity {
     identifier: string;
     generalType?: IGeneralTypesEntity;
     generalTypeId: number;
-    localizeInfos: Record<string, any>;
+    title: string;
     position: number;
     positionId?: number;
     generalTypeName: Types;

package/dist/templates-preview/templatesPreviewInterfaces.d.ts

@@ -34,7 +34,7 @@ interface ITemplatesPreviewEntity {
         vertical: IProportion | null;
         square: ISquare;
     };
-    localizeInfos: Record<string, any>;
+    title: string;
     position: number;
 }
 interface IProportion {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.63",
+  "version": "1.0.64",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",