oneentry 1.0.106 → 1.0.109

package/dist/formsData/formsDataApi.d.ts

@@ -20,24 +20,28 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      */
     getFormsData(langCode?: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
     /**
-     * Find all product page objects with pagination and multiple filtering.
+     * Creating an object of data save information by form
      *
-     * @param {object} [data] - Request body.
+     * @param {object} [body] - Request body.
      * @param {string} [langCode] - Optional language field
      *
      * @example
-     * const data = {
-     *    formIdentifier: 'test',
-     *    formData: {
-     *        marker: 'test',
-     *        value: 'Test',
-     *        type: 'string'
-     *    },
-     * }
+     *  const body = {
+          "formIdentifier": "reg",
+          "formData": {
+            "en_US": [
+              {
+                "marker": "last_name",
+                "type": "string",
+                "value": "Федор Иванов"
+              }
+            ]
+          }
+        }
      *
-     * @returns - Returns created FormData objects.
+     * @returns - Returns a created FormDataEntity object.
      */
-    postFormsData(data: IFormsPost, langCode?: string): Promise<IFormDataEntity | IError>;
+    postFormsData(body: IFormsPost, langCode?: string): Promise<IFormDataEntity | IError>;
     /**
      * Get one object of form data by marker.
      *

package/dist/formsData/formsDataApi.js

@@ -27,30 +27,34 @@ class FormsDataApi extends asyncModules_1.default {
         return this._dataPostProcess(result, langCode);
     }
     /**
-     * Find all product page objects with pagination and multiple filtering.
+     * Creating an object of data save information by form
      *
-     * @param {object} [data] - Request body.
+     * @param {object} [body] - Request body.
      * @param {string} [langCode] - Optional language field
      *
      * @example
-     * const data = {
-     *    formIdentifier: 'test',
-     *    formData: {
-     *        marker: 'test',
-     *        value: 'Test',
-     *        type: 'string'
-     *    },
-     * }
+     *  const body = {
+          "formIdentifier": "reg",
+          "formData": {
+            "en_US": [
+              {
+                "marker": "last_name",
+                "type": "string",
+                "value": "Федор Иванов"
+              }
+            ]
+          }
+        }
      *
-     * @returns - Returns created FormData objects.
+     * @returns - Returns a created FormDataEntity object.
      */
-    async postFormsData(data, langCode = this.state.lang) {
+    async postFormsData(body, langCode = this.state.lang) {
         const formData = {};
-        formData[langCode] = Array.isArray(data.formData)
-            ? data.formData
-            : [data.formData];
-        data.formData = formData;
-        const result = await this._fetchPost(``, data);
+        formData[langCode] = Array.isArray(body.formData)
+            ? body.formData
+            : [body.formData];
+        body.formData = formData;
+        const result = await this._fetchPost(``, body);
         return this._dataPostProcess(result);
     }
     /**

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

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { ICollection, ICollectionFormObject, ICollectionResponce, ICollectionsApi } from './integrationCollectionsInterfaces';
+import type { ICollection, ICollectionFormObject, ICollectionResponce, ICollectionRow, ICollectionsApi } from './integrationCollectionsInterfaces';
 /**
  * Controllers for working with attributes.
  */
@@ -24,7 +24,6 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     getICollections(langCode?: string, userQuery?: any): Promise<Array<ICollection> | IError>;
     /**
      * Get a single collection object by id.
-     * GET/api/content/integration-collections/{id}
      *
      * @param {number} [id] - Collection id.
      * @param {string} [langCode] - Language code.
@@ -34,7 +33,6 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     getICollectionById(id: number, langCode?: string): Promise<ICollection | IError>;
     /**
      * Get all records belonging to the collection by collection id.
-     * GET/api/content/integration-collections/{id}/rows
      *
      * @param {number} [id] - Collection id.
      * @param {string} [langCode] - Language code.
@@ -48,16 +46,16 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     getICollectionRowsById(id: number, langCode?: string, userQuery?: any): Promise<ICollectionResponce | IError>;
     /**
      * Check for the existence of a text identifier (marker)
-     * GET/api/content/integration-collections/marker-validation/{marker}
      *
-     * @param {string} [marker] - Collection id.
+     * @param {string} [marker] - Collection marker.
      *
      * @returns Returns object MarkerValidDto with value true if text identifier (marker) exists or false if not
      */
-    validateICollectionMarker(marker: string): Promise<any | IError>;
+    validateICollectionMarker(marker: string): Promise<{
+        valid: boolean;
+    } | IError>;
     /**
      * Getting one record from the collection.
-     * GET/api/content/integration-collections/marker/{marker}/rows/{id}
      *
      * @param {string} [marker] - Collection text identifier
      * @param {number} [id] - Collection record identifier
@@ -68,11 +66,10 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     getICollectionRowByMarkerAndId(marker: string, id: number, langCode?: string): Promise<any | IError>;
     /**
      * Create a record in the collection
-     * POST/api/content/integration-collections/marker/{marker}/rows
      *
      * @param {string} [marker] - Collection text identifier. Example : collection1
-     * @param {ICollectionFormObject} [data] - Object for creating a record
-     * const data: ICollectionFormObject = {
+     * @param {ICollectionFormObject} [body] - Object for creating a record
+     * const body: ICollectionFormObject = {
         "formIdentifier": "collection-form",
         "formData": {
           "en_US": [
@@ -88,13 +85,14 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      *
      * @description Create a record in the collection
      */
-    createICollectionRow(marker: string, data: ICollectionFormObject, langCode?: string): Promise<Array<any> | IError>;
+    createICollectionRow(marker: string, body: ICollectionFormObject, langCode?: string): Promise<any | IError>;
     /**
      * Edit a record in the collection
-     * PUT/api/content/integration-collections/marker/{marker}/rows/{id}
      *
-     * @param {string} marker - text identifier of the collection
-     * @param {any} body - Object UpdateCollectionRowDto for updating a record in the collection
+     * @param {string} [marker] - text identifier of the collection
+     * @param {number} [id] - row id
+     * @param {any} [body] - Object UpdateCollectionRowDto for updating a record in the collection
+     *
      * const body = {
         "formIdentifier": "collection-form",
         "formData": {
@@ -107,22 +105,22 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
           ]
         }
       }
-     * @param {string} langCode - language code
+     *
+     * @param {string} [langCode] - language code
      *
      * @returns Returns object UpdateCollectionRowDto
      */
     updateICollectionRow(marker: string, id: number, body: {
         formIdentifier: string;
         formData: any;
-    }, langCode?: string): Promise<any | IError>;
+    }, langCode?: string): Promise<ICollectionRow | IError>;
     /**
      * Deletion of collection record object
-     * DELETE/api/content/integration-collections/marker/{marker}/rows/{id} Удаление объекта записи коллекции
      *
-     * @param id - record identifier in the collection Example : 12
-     * @param marker - text identifier of the collection Example : collection1
+     * @param {string} [marker] - text identifier of the collection Example : collection1
+     * @param {number} [id] - record identifier in the collection Example : 12
      *
      * @returns Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
      */
-    deleteCollectionRowByMarker(marker: number, id: number): Promise<any | IError>;
+    deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<boolean | IError>;
 }

package/dist/integration-collections/integrationCollectionsApi.js

@@ -36,7 +36,6 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Get a single collection object by id.
-     * GET/api/content/integration-collections/{id}
      *
      * @param {number} [id] - Collection id.
      * @param {string} [langCode] - Language code.
@@ -50,7 +49,6 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Get all records belonging to the collection by collection id.
-     * GET/api/content/integration-collections/{id}/rows
      *
      * @param {number} [id] - Collection id.
      * @param {string} [langCode] - Language code.
@@ -68,9 +66,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Check for the existence of a text identifier (marker)
-     * GET/api/content/integration-collections/marker-validation/{marker}
      *
-     * @param {string} [marker] - Collection id.
+     * @param {string} [marker] - Collection marker.
      *
      * @returns Returns object MarkerValidDto with value true if text identifier (marker) exists or false if not
      */
@@ -80,7 +77,6 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Getting one record from the collection.
-     * GET/api/content/integration-collections/marker/{marker}/rows/{id}
      *
      * @param {string} [marker] - Collection text identifier
      * @param {number} [id] - Collection record identifier
@@ -94,11 +90,10 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Create a record in the collection
-     * POST/api/content/integration-collections/marker/{marker}/rows
      *
      * @param {string} [marker] - Collection text identifier. Example : collection1
-     * @param {ICollectionFormObject} [data] - Object for creating a record
-     * const data: ICollectionFormObject = {
+     * @param {ICollectionFormObject} [body] - Object for creating a record
+     * const body: ICollectionFormObject = {
         "formIdentifier": "collection-form",
         "formData": {
           "en_US": [
@@ -114,16 +109,17 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      *
      * @description Create a record in the collection
      */
-    async createICollectionRow(marker, data, langCode = this.state.lang) {
-        const response = await this._fetchPost(`/marker/${marker}/rows/?` + `langCode=${langCode}`, data);
+    async createICollectionRow(marker, body, langCode = this.state.lang) {
+        const response = await this._fetchPost(`/marker/${marker}/rows/?` + `langCode=${langCode}`, body);
         return this._normalizeData(response, langCode);
     }
     /**
      * Edit a record in the collection
-     * PUT/api/content/integration-collections/marker/{marker}/rows/{id}
      *
-     * @param {string} marker - text identifier of the collection
-     * @param {any} body - Object UpdateCollectionRowDto for updating a record in the collection
+     * @param {string} [marker] - text identifier of the collection
+     * @param {number} [id] - row id
+     * @param {any} [body] - Object UpdateCollectionRowDto for updating a record in the collection
+     *
      * const body = {
         "formIdentifier": "collection-form",
         "formData": {
@@ -136,7 +132,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
           ]
         }
       }
-     * @param {string} langCode - language code
+     *
+     * @param {string} [langCode] - language code
      *
      * @returns Returns object UpdateCollectionRowDto
      */
@@ -146,16 +143,15 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Deletion of collection record object
-     * DELETE/api/content/integration-collections/marker/{marker}/rows/{id} Удаление объекта записи коллекции
      *
-     * @param id - record identifier in the collection Example : 12
-     * @param marker - text identifier of the collection Example : collection1
+     * @param {string} [marker] - text identifier of the collection Example : collection1
+     * @param {number} [id] - record identifier in the collection Example : 12
      *
      * @returns Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
      */
-    async deleteCollectionRowByMarker(marker, id) {
+    async deleteICollectionRowByMarkerAndId(marker, id) {
         const result = await this._fetchDelete(`/marker/${marker}/rows/${id}`);
-        return result.json();
+        return result;
     }
 }
 exports.default = IntegrationCollectionsApi;

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

@@ -2,13 +2,14 @@ import type { IError } from '../base/utils';
 /**
  * Represents an interface object of ICollections Api.
  *
- * @property {function} getICollections - Get all collections
- * @property {function} getICollectionById - Get a single collection object
- * @property {function} getICollectionRowsById -
- * @property {function} validateICollectionMarker -
- * @property {function} getICollectionRowByMarkerAndId -
- * @property {function} createICollectionRow -
- * @property {function} updateICollectionRow -
+ * @property {function} [getICollections] - Get all collections
+ * @property {function} [getICollectionById] - Get a single collection object
+ * @property {function} [getICollectionRowsById] - Get all records belonging to the collection by collection id.
+ * @property {function} [validateICollectionMarker] - Check for the existence of a text identifier (marker)
+ * @property {function} [getICollectionRowByMarkerAndId] - Getting one record (row) from the collection.
+ * @property {function} [createICollectionRow] - Create a record (row) in the collection
+ * @property {function} [updateICollectionRow] - Edit a record (row) in the collection
+ * @property {function} [deleteICollectionRowByMarkerAndId] - Deletion of collection record object (row)
  */
 interface ICollectionsApi {
     getICollections(marker: string, langCode: string, userQuery?: any): Promise<Array<any> | IError>;
@@ -18,9 +19,17 @@ interface ICollectionsApi {
     getICollectionRowByMarkerAndId(marker: string, id: number, langCode: string): Promise<any | IError>;
     createICollectionRow(marker: string, body: any, langCode: string): Promise<Array<any> | IError>;
     updateICollectionRow(marker: string, id: number, body: any, langCode: string): Promise<any | IError>;
+    deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<any | IError>;
 }
 /**
  * ICollection
+ *
+ * @property {number} [id] - Object identifier
+ * @property {object} [localizeInfos] - Name considering localization
+ * @property {string | null} [identifier] - Text identifier for record field
+ * @property {number | null} [formId] - Identifier for the form used by the order storage
+ * @property {string | null} [attributeSetId] - Identifier of the set of attributes used by the form attached to the collection
+ * @property {string | null} [selectedAttributeMarkers] - Text identifiers of form object attributes for display in the data table
  */
 interface ICollection {
     id: number;
@@ -32,6 +41,9 @@ interface ICollection {
 }
 /**
  * ICollectionResponce
+ *
+ * @property {ICollection[]} items -
+ * @property {number} total -
  */
 interface ICollectionResponce {
     items: ICollection[];
@@ -39,6 +51,10 @@ interface ICollectionResponce {
 }
 /**
  * ICollectionFormData
+ *
+ * @property {string} marker -
+ * @property {string} type -
+ * @property {string} value -
  */
 interface ICollectionFormData {
     marker: string;
@@ -47,6 +63,9 @@ interface ICollectionFormData {
 }
 /**
  * ICollectionFormObject
+ *
+ * @property {string} formIdentifier -
+ * @property {object} formData -
  */
 interface ICollectionFormObject {
     formIdentifier: string;
@@ -54,4 +73,22 @@ interface ICollectionFormObject {
         [key: string]: ICollectionFormData[];
     };
 }
-export type { ICollection, ICollectionFormObject, ICollectionResponce, ICollectionsApi, };
+/**
+ * ICollectionRow
+ */
+interface ICollectionRow {
+    id: number;
+    createdDate: string;
+    updatedDate: string;
+    formData: ICollectionFormData[];
+    attributeSetIdentifier: string | null;
+    total?: string;
+}
+/**
+ * ICollectionRows
+ */
+interface ICollectionRowsResponce {
+    items: ICollectionRow[];
+    total: number;
+}
+export type { ICollection, ICollectionFormObject, ICollectionResponce, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, };

package/dist/menus/menusApi.d.ts

@@ -12,7 +12,7 @@ export default class MenusApi extends AsyncModules implements IMenus {
     /**
      * Get pages includes in menu by marker.
      *
-     * @param {string} marker - Menu marker
+     * @param {string} [marker] - Menu marker
      * @param {string} [langCode] - Language code
      *
      * @returns Returns a single menu object as a ContentMenu object with included pages

package/dist/menus/menusApi.js

@@ -15,7 +15,7 @@ class MenusApi extends asyncModules_1.default {
     /**
      * Get pages includes in menu by marker.
      *
-     * @param {string} marker - Menu marker
+     * @param {string} [marker] - Menu marker
      * @param {string} [langCode] - Language code
      *
      * @returns Returns a single menu object as a ContentMenu object with included pages

package/dist/orders/ordersApi.d.ts

@@ -9,6 +9,44 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
     protected state: StateModule;
     protected _url: string;
     constructor(state: StateModule);
+    /**
+     * Getting all the order storage objects
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     *
+     * @param {number} [langCode] - Optional language field
+     * @param {number} [offset] - Optional parameter for pagination, default is 0
+     * @param {number} [limit] - Optional parameter for pagination, default is 30
+     */
+    getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<Array<IOrdersEntity> | IError>;
+    /**
+     * Getting all orders from the orders storage object created by the user
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @param {string} [marker] - Textual identifier of the order storage object
+     * @param {string} [langCode] - Optional language field
+     * @param {number} [offset] - Offset parameter. Default 0
+     * @param {number} [limit] - Limit parameter. Default 30
+     */
+    getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
+    /**
+     * Retrieve one order storage object by marker.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @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 | IError>;
+    /**
+     * Getting a single order from the order storage object created by the user
+     *
+     * @param {string} [marker] - The text identifier of the order storage object
+     * @param {number} [id] - ID of the order object
+     * @param {string} [langCode] - Optional language field
+     *
+     */
+    getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
     /**
      * Creation of an order in the order storage.
      *
@@ -38,24 +76,14 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @returns Returns object for creating an order.
      */
     createOrder(marker: string, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
-    /**
-     * Getting all orders from the orders storage object created by the user
-     *
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @param {number} marker - Textual identifier of the order storage object
-     * @param {string} [langCode] Optional language field
-     * @param {number} [offset] Offset parameter. Default 0
-     * @param {number} [limit] Limit parameter. Default 30
-     */
-    getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
     /**
      * Changing an order in the orders storage
      *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @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
+     * @param {string} [marker] - The text identifier of the order storage object
+     * @param {number} [id] - ID of the order object
+     * @param {IOrderData} [body] - Object for updating an order
+     * @param {string} [langCode] - Optional language field
      *
      * @example
      * const body = {
@@ -75,33 +103,5 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      *   "currency": "USD"
      * }
      */
-    updateOrderByMarkerAndId(marker: string, id: number, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
-    /**
-     * Getting a single order from the order storage object created by the user
-     *
-     * @param marker - The text identifier of the order storage object
-     * @param id - ID of the order object
-     * @param langCode Optional language field
-     *
-     */
-    getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
-    /**
-     * Getting all the order storage objects
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     *
-     * @param {number} [langCode] Optional language field
-     * @param {number} [offset] - Optional parameter for pagination, default is 30
-     * @param {number} [limit] - Optional parameter for pagination, default is 0
-     */
-    getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<Array<IOrdersEntity> | IError>;
-    /**
-     * Retrieve one order storage object by marker.
-     *
-     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @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 | IError>;
+    updateOrderByMarkerAndId(marker: string, id: number, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
 }