oneentry 1.0.123 → 1.0.124

package/dist/formsData/formsDataInterfaces.d.ts

@@ -1,26 +1,64 @@
 import type { IUploadingQuery } from 'file-uploading/fileUploadingInterfaces';
 import type { IError } from '../base/utils';
 /**
- * Represents a interface object of Forms Api.
+ * Interface for retrieving and posting form data in the system.
+ *
+ * @interface IFormsData
  *
  * @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.
+ *
+ * @description This interface defines methods for retrieving and posting form data in the system.
  */
 interface IFormsData {
+    /**
+     * Retrieves all forms data.
+     *
+     * @param {string} langCode - The language code for localization. Default: "en_US".
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     *
+     * @return {IFormsDataEntity} A promise that resolves to a collection of form data entities or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getFormsData(langCode: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
+    /**
+     * Posts form data to the system.
+     *
+     * @param {IFormsPost} data - The form data to be posted.
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     *
+     * @return {IFormDataEntity} A promise that resolves to a form data entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     postFormsData(data: IFormsPost, langCode?: string): Promise<IFormDataEntity | IError>;
+    /**
+     * Retrieves form data by its marker.
+     *
+     * @param {string} marker - The marker identifying the form data. Example: "contact_form_data".
+     * @param {string} langCode - The language code for localization. Default: "en_US".
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     *
+     * @returns {IFormsDataEntity} A promise that resolves to a form data entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getFormsDataByMarker(marker: string, langCode: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
 }
 /**
- * Represents a form data.
+ * Represents the structure of a form data entity.
  *
- * @interface
- * @property {number} id - The unique identifier of the form page.
- * @property {string} formIdentifier - The identifier of the page.
- * @property {Date | string} time - The identifier of the form.
- * @property {IFormsPost} formData - The identifier of the position.
- * @property {string} attributeSetIdentifier - Text identifier (marker) of the used attribute set.
+ * @interface IFormDataEntity
+ *
+ * @property {number} id - The unique identifier of the form page. Example: 12345.
+ * @property {string} formIdentifier - The identifier of the page. Example: "contact_form".
+ * @property {Date | string} time - The identifier of the form. Example: "2023-10-01T12:00:00Z".
+ * @property {IFormsPost} formData - The identifier of the position. Example: .
+ * @property {string} [attributeSetIdentifier] - Text identifier (marker) of the used attribute set. Example: "product_attributes".
+ * @property {string} [actionMessage] - Action message for the form data. Example: "Form submitted successfully".
+ *
+ * @description This interface defines the structure of a form data entity, including its identifiers, form data, and optional attributes.
  */
 interface IFormDataEntity {
     id: number;
@@ -31,11 +69,14 @@ interface IFormDataEntity {
     actionMessage?: string;
 }
 /**
- * Represents a form data.
+ * Represents a collection of form data entities.
+ *
+ * @interface IFormsDataEntity
  *
- * @interface
- * @property {number} total - Total number of found records.
- * @property {Array<IFormDataEntity>} items
+ * @property {number} total - Total number of found records. Example: 100.
+ * @property {Array<IFormDataEntity>} items - Array of form data objects. Example: .
+ *
+ * @description This interface defines the structure of a collection of form data entities, including a total count and an array of items.
  */
 interface IFormsDataEntity {
     total: number;
@@ -46,12 +87,17 @@ interface IFormsDataEntity {
  */
 type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeText | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | IBodyTypeRadioButtonList | Record<string, any>;
 /**
- * interface to create an object of information about saving data using the form
+ * Represents the structure of a form post object.
+ *
+ * @interface IFormsPost
  *
- * @property {number} id
+ * @property {number} [id] - Optional identifier of the form post.
  * @property {string} formIdentifier - The identifier of the page.
- * @property {Date | string} time - Date and time of form modification
+ * @property {Date | string} [time] - Date and time of form modification.
  * @property {Array<FormDataType>} formData - The identifier of the page.
+ * @property {IUploadingQuery} [fileQuery] - Optional file query for uploading files.
+ *
+ * @description This interface defines the structure of a form post object, including its identifiers, time, form data, and optional file query.
  */
 interface IFormsPost {
     id?: number;
@@ -61,9 +107,15 @@ interface IFormsPost {
     fileQuery?: IUploadingQuery;
 }
 /**
- * @property {string} marker - marker name
- * @property {'string' | 'number' | 'float'} type - Type value
- * @property {string} value
+ * Represents a form data entity with a simple value.
+ *
+ * @interface IBodyTypeStringNumberFloat
+ *
+ * @property {string} marker - marker name.
+ * @property {'string' | 'number' | 'float'} type - Type value.
+ * @property {string} value - Value of the form data entity, which can be a string, number, or float.
+ *
+ * @description Represents a form data entity with a marker, type, and value.
  */
 interface IBodyTypeStringNumberFloat {
     marker: string;
@@ -71,9 +123,15 @@ interface IBodyTypeStringNumberFloat {
     value: string;
 }
 /**
- * @property {string} marker - marker name
- * @property {'date' | 'dateTime' | 'time'} type - Type value
- * @property {object} value - Date object. Contains fullDate, formattedValue, formatString
+ * Represents a date/time form data entity.
+ *
+ * @interface IBodyTypeTimeDate
+ *
+ * @property {string} marker - marker name.
+ * @property {'date' | 'dateTime' | 'time'} type - Type value.
+ * @property {object} value - Date object. Contains fullDate, formattedValue, formatString.
+ *
+ * @description Represents a date, dateTime, or time value in a structured format.
  */
 interface IBodyTypeTimeDate {
     marker: string;
@@ -85,9 +143,15 @@ interface IBodyTypeTimeDate {
     };
 }
 /**
- * @property {string} marker - marker name
- * @property {'text'} type - Type value
- * @property {object} value - Text Object. Contains html as string and params
+ * Represents a text form data entity.
+ *
+ * @interface IBodyTypeText
+ *
+ * @property {string} marker - marker name.
+ * @property {'text'} type - Type value.
+ * @property {object} value - Text Object. Contains html as string, plain text and params.
+ *
+ * @description Represents a text value with HTML and plain text representations, along with parameters for editor and image compression settings.
  */
 interface IBodyTypeText {
     marker: string;
@@ -102,9 +166,15 @@ interface IBodyTypeText {
     };
 }
 /**
- * @property {string} marker - marker name
- * @property {'textWithHeader'} type - Type value
- * @property {object} value - Text Object. Contains html as string, header and params
+ * Represents a text with header form data entity.
+ *
+ * @interface IBodyTypeTextWithHeader
+ *
+ * @property {string} marker - marker name.
+ * @property {'textWithHeader'} type - Type value.
+ * @property {object} value - Text Object. Contains html as string, header and params.
+ *
+ * @description Represents a text value with a header, HTML and plain text representations, along with parameters for editor and image compression settings.
  */
 interface IBodyTypeTextWithHeader {
     marker: string;
@@ -120,9 +190,15 @@ interface IBodyTypeTextWithHeader {
     };
 }
 /**
- * @property {string} marker - marker name
- * @property {'image' | 'groupOfImage'} type - Type value
- * @property {object} value - Image Object. Contains image information
+ * Represents an image or group of images form data entity.
+ *
+ * @interface IBodyTypeImageGroupOfImages
+ *
+ * @property {string} marker - marker name.
+ * @property {'image' | 'groupOfImage'} type - Type value.
+ * @property {object} value - Image Object. Contains image information.
+ *
+ * @description Represents an image or a group of images with their details, including filename, download link, size, preview link, and parameters for image compression.
  */
 interface IBodyTypeImageGroupOfImages {
     marker: string;
@@ -146,9 +222,15 @@ interface IBodyTypeImageGroupOfImages {
     }>;
 }
 /**
- * @property {string} marker - marker name
- * @property {'file'} type - Type value
- * @property {object} value - File Object. Contains file information
+ * Represents a file form data entity.
+ *
+ * @interface IBodyTypeFile
+ *
+ * @property {string} marker - marker name.
+ * @property {'file'} type - Type value.
+ * @property {object} value - File Object. Contains file information.
+ *
+ * @description Represents a file with its details, including filename, download link, and size.
  */
 interface IBodyTypeFile {
     marker: string;
@@ -160,9 +242,15 @@ interface IBodyTypeFile {
     };
 }
 /**
- * @property {string} marker - marker name
- * @property {'file'} type - Type value
+ * Represents a radio button or list selection form data entity.
+ *
+ * @interface IBodyTypeRadioButtonList
+ *
+ * @property {string} marker - marker name.
+ * @property {'file'} type - Type value.
  * @property {array} value - Array of list or radioButton bojects.
+ *
+ * @description Represents a list or radio button selection with multiple options, each containing a title, value, and extended information.
  */
 interface IBodyTypeRadioButtonList {
     marker: string;

package/dist/general-types/generalTypesApi.d.ts

@@ -4,7 +4,13 @@ import type { IError } from '../base/utils';
 import type { IGeneralTypes, IGeneralTypesEntity } from './generalTypesInterfaces';
 /**
  * Controllers for working with types
+ *
  * @handle /api/content/general-types
+ * @class GeneralTypesApi
+ * @extends AsyncModules
+ * @implements {IGeneralTypes}
+ *
+ * @description This class provides methods to interact with general types, including retrieving all types.
  */
 export default class GeneralTypesApi extends AsyncModules implements IGeneralTypes {
     protected state: StateModule;
@@ -13,7 +19,12 @@ export default class GeneralTypesApi extends AsyncModules implements IGeneralTyp
     /**
      * Get all types.
      *
-     * @returns Returns all objects of type GeneralTypeEntity
+     * @handleName getAllTypes
+     *
+     * @return {IGeneralTypesEntity[]} Returns an array of general types or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method retrieves all general types available in the system.
      */
     getAllTypes(): Promise<Array<IGeneralTypesEntity> | IError>;
 }

package/dist/general-types/generalTypesApi.js

@@ -6,7 +6,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with types
+ *
  * @handle /api/content/general-types
+ * @class GeneralTypesApi
+ * @extends AsyncModules
+ * @implements {IGeneralTypes}
+ *
+ * @description This class provides methods to interact with general types, including retrieving all types.
  */
 class GeneralTypesApi extends asyncModules_1.default {
     constructor(state) {
@@ -16,7 +22,12 @@ class GeneralTypesApi extends asyncModules_1.default {
     /**
      * Get all types.
      *
-     * @returns Returns all objects of type GeneralTypeEntity
+     * @handleName getAllTypes
+     *
+     * @return {IGeneralTypesEntity[]} Returns an array of general types or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method retrieves all general types available in the system.
      */
     async getAllTypes() {
         const result = await this._fetchGet('');

package/dist/general-types/generalTypesInterfaces.d.ts

@@ -1,19 +1,32 @@
 import type { BlockType } from 'blocks/blocksInterfaces';
 import type { IError } from '../base/utils';
 /**
- * Represents an interface object of General Type Api.
+ * Interface for retrieving all general types in the system.
+ *
+ * @interface IGeneralTypes
  *
  * @property {function} getAllTypes - Get all types.
+ *
+ * @description This interface defines a method for retrieving all general types in the system.
  */
 interface IGeneralTypes {
+    /**
+     * Get all types.
+     *
+     * @return {IGeneralTypesEntity[]} Returns an array of general types or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getAllTypes(): Promise<Array<IGeneralTypesEntity> | IError>;
 }
 /**
- * Represents a general types object.
+ * Represents a general type entity.
+ *
+ * @interface IGeneralTypesEntity
+ *
+ * @property {number} id - Type id. Example: 1.
+ * @property {Types} type - Types enum. Example: 'product', 'category', etc.
  *
- * @interface
- * @property {number} id - Type id.
- * @property {Types} type - Types enum.
+ * @description Represents a general type entity with an identifier and a type.
  */
 interface IGeneralTypesEntity {
     id: number;

package/dist/index.d.ts

@@ -66,7 +66,7 @@ interface IDefineApi {
  * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
  * @param {string} [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
  *
- * @returns {IDefineApi} - List of methods set.
+ * @return List of methods set.
  */
 export declare function defineOneEntry(url: string, config: IConfig): IDefineApi;
 export {};

package/dist/index.js

@@ -44,7 +44,7 @@ const wsApi_1 = __importDefault(require("./web-socket/wsApi"));
  * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
  * @param {string} [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
  *
- * @returns {IDefineApi} - List of methods set.
+ * @return List of methods set.
  */
 function defineOneEntry(url, config) {
     const stateModule = new stateModule_1.default(url.endsWith('/') ? url.slice(0, -1) : url, config);

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

@@ -4,7 +4,13 @@ import type { IError } from '../base/utils';
 import type { ICollection, ICollectionFormObject, ICollectionResponce, ICollectionRow, ICollectionsApi } from './integrationCollectionsInterfaces';
 /**
  * Controllers for working with attributes.
+ *
  * @handle /api/content/integration-collections
+ * @class IntegrationCollectionsApi
+ * @extends AsyncModules
+ * @implements {ICollectionsApi}
+ *
+ * @description This class provides methods to interact with integration collections, including retrieving all collections, getting a single collection by ID, and managing collection rows.
  */
 export default class IntegrationCollectionsApi extends AsyncModules implements ICollectionsApi {
     protected state: StateModule;
@@ -12,47 +18,68 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     constructor(state: StateModule);
     private _defaultQuery;
     /**
-     * Get all collections
+     * Get all collections.
      *
-     * @param {string} [langCode] - Language code.
+     * @handleName getICollections
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {any} [userQuery] - Optional set query parameters.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.entityType] - Entity type. Example: 1.
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: orders.
      *
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
+     * @return {ICollection[]} Returns an array of ICollection objects or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns an array of ICollections 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.
      */
     getICollections(langCode?: string, userQuery?: any): Promise<Array<ICollection> | IError>;
     /**
      * Get a single collection object by id.
      *
-     * @param {number} [id] - Collection id.
-     * @param {string} [langCode] - Language code.
+     * @handleName getICollectionById
+     *
+     * @param {number} id - Collection id. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {ICollection} Returns an ICollection object or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns single ICollection object.
+     * @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.
      */
     getICollectionById(id: number, langCode?: string): Promise<ICollection | IError>;
     /**
      * Get all records belonging to the collection by collection id.
      *
-     * @param {number} [id] - Collection id.
-     * @param {string} [langCode] - Language code.
-     * @param {any} [userQuery] - Optional set query parameters.
+     * @handleName getICollectionRowsById
+     *
+     * @param {number} id - Collection id. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {any} [userQuery] - Optional set query parameters. Example: .
+     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.entityType] - Entity type. Example: 1.
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: "orders".
      *
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     * @param {number} [userQuery.entityType] - Entity type. Example: 1
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: orders
+     * @return {ICollectionResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns object ItemsWithTotal, where items is an array of requested objects
+     * @description Get all records belonging to the collection by collection id.
      */
     getICollectionRowsById(id: number, langCode?: string, userQuery?: any): Promise<ICollectionResponce | IError>;
     /**
-     * Check for the existence of a text identifier (marker)
+     * Check for the existence of a text identifier (marker).
      *
-     * @param {string} [marker] - Collection marker.
+     * @handleName validateICollectionMarker
      *
-     * @returns Returns object with value true if text identifier (marker) exists or false if not
+     * @param {string} marker - Collection marker. Example: "collection1".
+     *
+     * @return {any} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     validateICollectionMarker(marker: string): Promise<{
         valid: boolean;
@@ -60,67 +87,61 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     /**
      * Getting all records from the collection.
      *
-     * @param {string} [marker] - Collection text identifier
-     * @param {string} [langCode] - Language code.
+     * @handleName getICollectionRowsByMarker
+     *
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns CollectionRowEntity object.
+     * @return {any} Returns CollectionRowEntity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @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.
      */
     getICollectionRowsByMarker(marker: string, langCode?: string): Promise<any | IError>;
     /**
      * Getting one record from the collection.
      *
-     * @param {string} [marker] - Collection text identifier
-     * @param {number} [id] - Collection record identifier
-     * @param {string} [langCode] - Language code.
+     * @handleName getICollectionRowByMarkerAndId
+     *
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {number} id - Collection record identifier. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns CollectionRowEntity object.
+     * @return {any} Returns CollectionRowEntity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @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.
      */
     getICollectionRowByMarkerAndId(marker: string, id: number, langCode?: string): Promise<any | IError>;
     /**
-     * Create a record in the collection
-     *
-     * @param {string} [marker] - Collection text identifier. Example : collection1
-     * @param {ICollectionFormObject} [body] - Object for creating a record
-     * const body: ICollectionFormObject = {
-        "formIdentifier": "collection-form",
-        "formData": {
-          "en_US": [
-            {
-              "marker": "collection_marker",
-              "type": "string",
-              "value": "Collection marker"
-            }
-          ]
-        }
-      }
-     * @param {string} [langCode] - Language code.
-     *
-     * @description Create a record in the collection
+     * Create a record in the collection.
+     *
+     * @handleName createICollectionRow
+     *
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {ICollectionFormObject} body - Object for creating a record. Example: { "formIdentifier": "collection-form", "formData": { "en_US": [ { "marker": "collection_marker", "type": "string", "value": "Collection marker" } ] } }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {any} Returns object of type ICollectionRow.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Create a record in the collection.
      */
     createICollectionRow(marker: string, body: ICollectionFormObject, langCode?: string): Promise<any | IError>;
     /**
-     * Edit a record in the collection
-     *
-     * @param {string} [marker] - text identifier of the collection
-     * @param {number} [id] - row id
-     * @param {any} [body] - Object for updating a record in the collection
-     *
-     * const body = {
-        "formIdentifier": "collection-form",
-        "formData": {
-          "en_US": [
-            {
-              "marker": "collection_marker",
-              "type": "string",
-              "value": "Collection marker"
-            }
-          ]
-        }
-      }
-     *
-     * @param {string} [langCode] - language code
-     *
-     * @returns Returns object
+     * Edit a record in the collection.
+     *
+     * @handleName updateICollectionRow
+     *
+     * @param {string} marker - Text identifier of the collection. Example: "collection1".
+     * @param {number} id - Row identifier in the collection. Example: 12.
+     * @param {object} body - Object for updating a record in the collection. Example: { "formIdentifier": "collection-form", "formData": { "en_US": [ { "marker": "collection_marker", "type": "string", "value": "Collection marker" } ] } }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {ICollectionRow} Returns object of type ICollectionRow.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Edit a record in the collection.
      */
     updateICollectionRow(marker: string, id: number, body: {
         formIdentifier: string;
@@ -129,10 +150,15 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     /**
      * Deletion of collection record object
      *
-     * @param {string} [marker] - text identifier of the collection Example : collection1
-     * @param {number} [id] - record identifier in the collection Example : 12
+     * @handleName deleteICollectionRowByMarkerAndId
+     *
+     * @param {string} marker - text identifier of the collection Example: "collection1".
+     * @param {number} id - record identifier in the collection Example: 12.
+     *
+     * @return {boolean} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @description
      */
     deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<boolean | IError>;
 }