oneentry 1.0.130 → 1.0.131

package/dist/events/eventsApi.js

@@ -34,7 +34,8 @@ class EventsApi extends asyncModules_1.default {
      * @param {number} [limit] - Optional limit for pagination. Default: 30.
      * @returns {ISubscriptions} Returns an object containing all subscriptions 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     async getAllSubscriptions(offset = 0, limit = 30) {
         const query = {
@@ -52,7 +53,8 @@ class EventsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".=
      * @returns {Promise<boolean | IError>} Returns true if subscription was successful, 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     async subscribeByMarker(marker, productId, langCode = this.state.lang) {
         const body = {
@@ -75,7 +77,8 @@ class EventsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {any} - Returns a promise that resolves to the result of the unsubscription operation 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     async unsubscribeByMarker(marker, productId, langCode = this.state.lang) {
         const body = {

package/dist/events/eventsInterfaces.d.ts

@@ -42,7 +42,8 @@ interface IEvents {
  * Represents a response from the events API containing a total count and an array of subscription items.
  * @interface ISubscriptions
  * @property {number} total - Total number of found records. Example: 100.
- * @property {{ eventMarker: string; productId: number }[]} items - Array of subscription items, each containing an event marker and a product ID. Example:
+ * @property {{ eventMarker: string; productId: number }[]} items - Array of subscription items, each containing an event marker and a product ID.
+ * @example
    [
      {
        eventMarker: 'product_price_change',

package/dist/file-uploading/fileUploadingApi.d.ts

@@ -14,15 +14,17 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
     protected state: StateModule;
     protected _url: string;
     /**
-     *
+     * Constructs a new instance of the FileUploadingApi class.
      */
     constructor(state: StateModule);
+    /** FileUploadingApi class */
     private _defaultQuery;
     /**
      * Upload file function.
      * @handleName upload
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -41,14 +43,16 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @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.
+     * @description This method requires user authorization.
+     * @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}.
      */
     upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
     /**
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} filename - File name. Example: "file.png".
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -61,7 +65,8 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {any} Returns a promise that resolves to the result of the deletion operation 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     delete(filename: string, fileQuery?: IUploadingQuery): Promise<any | IError>;
     /**
@@ -74,7 +79,8 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {string} [template] - Preview template identifier. Example: 1.
      * @returns {any} Returns a promise that resolves to a Blob object containing the file data 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     getFile(id: number, type: string, entity: string, filename: string, template?: string): Promise<any | IError>;
 }

package/dist/file-uploading/fileUploadingApi.js

@@ -16,10 +16,11 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
  */
 class FileUploadingApi extends asyncModules_1.default {
     /**
-     *
+     * Constructs a new instance of the FileUploadingApi class.
      */
     constructor(state) {
         super(state);
+        /** FileUploadingApi class */
         this._defaultQuery = {
             type: null,
             entity: null,
@@ -34,7 +35,8 @@ class FileUploadingApi extends asyncModules_1.default {
      * Upload file function.
      * @handleName upload
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -53,7 +55,8 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @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.
+     * @description This method requires user authorization.
+     * @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}.
      */
     async upload(file, fileQuery) {
         const query = { ...this._defaultQuery, ...fileQuery };
@@ -66,7 +69,8 @@ class FileUploadingApi extends asyncModules_1.default {
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} filename - File name. Example: "file.png".
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -79,7 +83,8 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {any} Returns a promise that resolves to the result of the deletion operation 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     async delete(filename, fileQuery) {
         const query = { ...this._defaultQuery, ...fileQuery };
@@ -96,7 +101,8 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {string} [template] - Preview template identifier. Example: 1.
      * @returns {any} Returns a promise that resolves to a Blob object containing the file data 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     async getFile(id, type, entity, filename, template) {
         // eslint-disable-next-line no-undef

package/dist/file-uploading/fileUploadingInterfaces.d.ts

@@ -12,7 +12,8 @@ interface IFileUploading {
      * Upload file function.
      * @handleName upload
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -31,14 +32,16 @@ interface IFileUploading {
      * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @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.
+     * @description This method requires user authorization.
+     * @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}.
      */
     upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
     /**
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} [filename] - File name. Example: "file.png".
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
         {
           "type": "page",
           "entity": "editor",
@@ -51,7 +54,8 @@ interface IFileUploading {
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {any} Returns a promise that resolves to the result of the deletion operation 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     delete(filename: string, fileQuery?: IUploadingQuery): Promise<any | IError>;
     /**
@@ -63,7 +67,8 @@ interface IFileUploading {
      * @param {string} [filename] - Optional filename to retrieve. Example: "file.png".
      * @returns {Blob} A promise that resolves to a Blob object or an error.
      * @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.
+     * @description This method requires user authorization.
+     * @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}.
      */
     getFile(id: number, type: string, entity: string, filename?: string): Promise<any | IError>;
 }

package/dist/forms/formsApi.d.ts

@@ -28,7 +28,8 @@ export default class FormsApi extends AsyncModules implements IForms {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IFormsEntity[]} Returns array for all objects of type FormEntity.
      * @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.
+     * @description This method requires user authorization.
+     * @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}.
      */
     getAllForms(langCode?: string, offset?: number, limit?: number): Promise<IFormsEntity[] | IError>;
     /**
@@ -38,7 +39,8 @@ export default class FormsApi extends AsyncModules implements IForms {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IFormsEntity} Returns object of type FormEntity.
      * @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.
+     * @description This method requires user authorization.
+     * @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}.
      */
     getFormByMarker(marker: string, langCode?: string): Promise<IFormsEntity | IError>;
 }

package/dist/forms/formsApi.js

@@ -31,7 +31,8 @@ class FormsApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IFormsEntity[]} Returns array for all objects of type FormEntity.
      * @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.
+     * @description This method requires user authorization.
+     * @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}.
      */
     async getAllForms(langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
@@ -44,7 +45,8 @@ class FormsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IFormsEntity} Returns object of type FormEntity.
      * @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.
+     * @description This method requires user authorization.
+     * @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}.
      */
     async getFormByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

package/dist/forms/formsInterfaces.d.ts

@@ -37,7 +37,8 @@ interface IForms {
  * @property {number} pageId - The identifier of the page. Example: 12.
  * @property {number} formId - The identifier of the form. Example: 321.
  * @property {number} positionId - The identifier of the position. Example: 1.
- * @property {IPosition} position - The position object. Example:
+ * @property {IPosition} position - The position object.
+ * @example
     {
       "id": 1,
       "position": 1,

package/dist/forms-data/formsDataApi.d.ts

@@ -25,13 +25,15 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IFormsDataEntity} Returns an object containing all forms data 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     getFormsData(langCode?: string, offset?: number, limit?: number): Promise<IFormsDataEntity | IError>;
     /**
      * Creating an object of data save information by form
      * @handleName postFormsData
-     * @param {IBodyPostFormData} body - Request body. Example:
+     * @param {IBodyPostFormData} body - Request body.
+     * @example
         {
           "formIdentifier": "test-form",
           "formModuleConfigId": 2,
@@ -47,7 +49,12 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
           ]
         }
      * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
-     * @param {FormDataType[]} body.formData - Form data. Example:
+     * @param {number} body.formModuleConfigId - The ID of the form module configuration. Example: 2.
+     * @param {string} body.moduleEntityIdentifier - The identifier of the module entity. Example: "form".
+     * @param {string | null} [body.replayTo] - The email address to which the reply should be sent.
+     * @param {string | null} [body.status] - The status of the form submission.
+     * @param {FormDataType[]} body.formData - Form data.
+     * @example
         [
           {
             "marker": "name",
@@ -55,13 +62,14 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
             "value": "Jack"
           }
         ]
-     * @param {string} body.formData.marker - The marker identifying the form field. Example: "name".
-     * @param {string} body.formData.type - The type of the form field. Example: "string".
-     * @param {string} body.formData.value - The value of the form field. Example: "Jack".
+     * @param {string} body.formData[].marker - The marker identifying the form field. Example: "name".
+     * @param {string} body.formData[].type - The type of the form field. Example: "string".
+     * @param {string} body.formData[].value - The value of the form field. Example: "Jack".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IPostFormResponse} Returns an object containing the created form data entry and message.
      * @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.
+     * @description This method requires user authorization.
+     * @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}.
      */
     postFormsData(body: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
     /**
@@ -69,7 +77,8 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @handleName getFormsDataByMarker
      * @param {string} marker - Marker of the form. Example: "contact_form".
      * @param {number} formModuleConfigId - Form module configuration ID. Example: 4.
-     * @param {object} [body] - Request body. Example:
+     * @param {object} [body] - Request body.
+     * @example
         {
           "entityIdentifier": "test",
           "userIdentifier": "",
@@ -83,7 +92,8 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IFormsByMarkerDataEntity} Returns an object containing the form data 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: object, isNested?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsByMarkerDataEntity | IError>;
 }

package/dist/forms-data/formsDataApi.js

@@ -31,7 +31,8 @@ class FormsDataApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IFormsDataEntity} Returns an object containing all forms data 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     async getFormsData(langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
@@ -40,7 +41,8 @@ class FormsDataApi extends asyncModules_1.default {
     /**
      * Creating an object of data save information by form
      * @handleName postFormsData
-     * @param {IBodyPostFormData} body - Request body. Example:
+     * @param {IBodyPostFormData} body - Request body.
+     * @example
         {
           "formIdentifier": "test-form",
           "formModuleConfigId": 2,
@@ -56,7 +58,12 @@ class FormsDataApi extends asyncModules_1.default {
           ]
         }
      * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
-     * @param {FormDataType[]} body.formData - Form data. Example:
+     * @param {number} body.formModuleConfigId - The ID of the form module configuration. Example: 2.
+     * @param {string} body.moduleEntityIdentifier - The identifier of the module entity. Example: "form".
+     * @param {string | null} [body.replayTo] - The email address to which the reply should be sent.
+     * @param {string | null} [body.status] - The status of the form submission.
+     * @param {FormDataType[]} body.formData - Form data.
+     * @example
         [
           {
             "marker": "name",
@@ -64,13 +71,14 @@ class FormsDataApi extends asyncModules_1.default {
             "value": "Jack"
           }
         ]
-     * @param {string} body.formData.marker - The marker identifying the form field. Example: "name".
-     * @param {string} body.formData.type - The type of the form field. Example: "string".
-     * @param {string} body.formData.value - The value of the form field. Example: "Jack".
+     * @param {string} body.formData[].marker - The marker identifying the form field. Example: "name".
+     * @param {string} body.formData[].type - The type of the form field. Example: "string".
+     * @param {string} body.formData[].value - The value of the form field. Example: "Jack".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IPostFormResponse} Returns an object containing the created form data entry and message.
      * @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.
+     * @description This method requires user authorization.
+     * @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}.
      */
     async postFormsData(body, langCode = this.state.lang) {
         const formData = {};
@@ -130,7 +138,8 @@ class FormsDataApi extends asyncModules_1.default {
      * @handleName getFormsDataByMarker
      * @param {string} marker - Marker of the form. Example: "contact_form".
      * @param {number} formModuleConfigId - Form module configuration ID. Example: 4.
-     * @param {object} [body] - Request body. Example:
+     * @param {object} [body] - Request body.
+     * @example
         {
           "entityIdentifier": "test",
           "userIdentifier": "",
@@ -144,7 +153,8 @@ class FormsDataApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {IFormsByMarkerDataEntity} Returns an object containing the form data 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 requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     * @description This method requires user authorization.
+     * @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}.
      */
     async getFormsDataByMarker(marker, formModuleConfigId, body = {}, isNested = 1, langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchPost(`/marker/${marker}?formModuleConfigId=${formModuleConfigId}&isNested=${isNested}&langCode=${langCode}&offset=${offset}&limit=${limit}`, body);

package/dist/forms-data/formsDataInterfaces.d.ts

@@ -23,7 +23,8 @@ interface IFormsData {
     /**
      * Creating an object of data save information by form
      * @handleName postFormsData
-     * @param {IBodyPostFormData} body - Request body. Example:
+     * @param {IBodyPostFormData} body - Request body.
+     * @example
         {
           "formIdentifier": "test-form",
           "formModuleConfigId": 2,
@@ -39,7 +40,12 @@ interface IFormsData {
           ]
         }
      * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
-     * @param {FormDataType[]} body.formData - Form data. Example:
+     * @param {number} body.formModuleConfigId - The ID of the form module configuration. Example: 2.
+     * @param {string} body.moduleEntityIdentifier - The identifier of the module entity. Example: "form".
+     * @param {string | null} [body.replayTo] - The email address to which the reply should be sent.
+     * @param {string | null} [body.status] - The status of the form submission.
+     * @param {FormDataType[]} body.formData - Form data.
+     * @example
         [
           {
             "marker": "name",
@@ -53,7 +59,6 @@ interface IFormsData {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IPostFormResponse} Returns an object containing the created form data entry and message.
      * @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.
      */
     postFormsData(body: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
     /**
@@ -61,7 +66,8 @@ interface IFormsData {
      * @handleName getFormsDataByMarker
      * @param {string} marker - The marker identifying the form data. Example: "contact_form_data".
      * @param {number} formModuleConfigId - The form module configuration ID. Example: 4.
-     * @param {object} [body] - Request body. Default: {}. Example:
+     * @param {object} [body] - Request body. Default: {}.
+     * @example
         {
           "entityIdentifier": "test",
           "userIdentifier": "",
@@ -85,7 +91,8 @@ interface IFormsData {
  * @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 {FormDataType[]} formData - Form data. Example:
+ * @property {FormDataType[]} formData - Form data.
+ * @example
     [
       {
         "marker": "name",
@@ -108,7 +115,8 @@ interface IFormDataEntity {
 /**
  * Represents a collection of form data entities.
  * @interface IFormsDataEntity
- * @property {IFormDataEntity[]} items - Array of form data objects. Example:
+ * @property {IFormDataEntity[]} items - Array of form data objects.
+ * @example
     [
       {
         "id": 1,
@@ -136,7 +144,8 @@ interface IFormsDataEntity {
  * @property {string | null} [ip] - Ip. Example: '127.0.0.1'.
  * @property {string | null} [status] - Status. Example: 'approved'.
  * @property {string | null} [userIdentifier] - Text identifier (marker) of the user. Example: "admin".
- * @property {FormDataType[]} formData - Form data. Example:
+ * @property {FormDataType[]} formData - Form data.
+ * @example
     [
       {
         "marker": "name",
@@ -169,7 +178,8 @@ interface IFormByMarkerDataEntity {
 /**
  * Represents a collection of form data entities.
  * @interface IFormsByMarkerDataEntity
- * @property {IFormByMarkerDataEntity[]} items - Array of form data objects. Example:
+ * @property {IFormByMarkerDataEntity[]} items - Array of form data objects.
+ * @example
     [
       {
         "id": 42,
@@ -204,7 +214,8 @@ interface IFormsByMarkerDataEntity {
  * Represents the structure of the response after posting form data.
  * @interface IPostFormResponse
  * @property {string} actionMessage - Action message for the form data. Example: "Form submitted successfully".
- * @property {object} formData - Form data. Example:
+ * @property {object} formData - Form data.
+ * @example
     {
       "id": 42,
       "formIdentifier": "contact_form",
@@ -230,7 +241,8 @@ interface IFormsByMarkerDataEntity {
  * @property {number} formData.formModuleId - The form module identifier. Example: 2.
  * @property {any} formData.parentId - The parent identifier. Example: null.
  * @property {any} formData.userIdentifier - The user identifier. Example: null.
- * @property {FormDataType[]} formData.formData - Form fields data. Example:
+ * @property {FormDataType[]} formData.formData - Form fields data.
+ * @example
     [
       {
         "marker": "name",
@@ -266,7 +278,8 @@ type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeTe
  * @property {string} moduleEntityIdentifier - Text identifier (marker) of the module entity. Example: "blog".
  * @property {string | null} replayTo - Email to reply to. Example: "some@email.com".
  * @property {string} status - Status of the form. Example: "sent".
- * @property {FormDataType[]} formData - Array of form data objects. Example:
+ * @property {FormDataType[]} formData - Array of form data objects.
+ * @example
     [
       {
         "marker": "name",
@@ -277,7 +290,8 @@ type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeTe
  * @property {string} formData[index].marker - The marker identifying the form field. Example: "name".
  * @property {string} formData[index].type - The type of the form field. Example: "string".
  * @property {string} formData[index].value - The value of the form field. Example: "name".
- * @property {IUploadingQuery} [fileQuery] - Optional file query for uploading files. Example:
+ * @property {IUploadingQuery} [fileQuery] - Optional file query for uploading files.
+ * @example
     {
       "type": "page",
       "entity": "editor",
@@ -312,7 +326,8 @@ interface IBodyTypeStringNumberFloat {
  * @interface IBodyTypeTimeDate
  * @property {string} marker - marker name. Example: "ome_marker".
  * @property {string} type - Type value. 'date' | 'dateTime' | 'time' Example: "date".
- * @property {object} value - Date object. Contains fullDate, formattedValue, formatString. Example:
+ * @property {object} value - Date object. Contains fullDate, formattedValue, formatString.
+ * @example
     {
       "fullDate": "2024-05-07T21:02:00.000Z",
       "formattedValue": "08-05-2024 00:02",
@@ -334,7 +349,8 @@ interface IBodyTypeTimeDate {
  * @interface IBodyTypeText
  * @property {string} marker - marker name. Example: "some_marker".
  * @property {string} type - Type value. Example: "text".
- * @property {object} value - Text Object. Contains html as string, plain text and params. Example:
+ * @property {object} value - Text Object. Contains html as string, plain text and params.
+ * @example
     {
       "htmlValue": "<p>Hello world</p>",
       "plainValue": "",
@@ -362,7 +378,8 @@ interface IBodyTypeText {
  * @interface IBodyTypeTextWithHeader
  * @property {string} marker - marker name. Example: "about".
  * @property {string} type - Type value. Example: "textWithHeader".
- * @property {object} value - Text Object. Contains html as string, header and params. Example:
+ * @property {object} value - Text Object. Contains html as string, header and params.
+ * @example
     {
       "header": "Headline",
       "htmlValue": "<p>Hello World</p>",
@@ -392,7 +409,8 @@ interface IBodyTypeTextWithHeader {
  * @interface IBodyTypeImageGroupOfImages
  * @property {string} marker - marker name. Example: "avatar".
  * @property {'image' | 'groupOfImage'} type - Type value. Example: "image".
- * @property {object} value - Image Object. Contains image information. Example:
+ * @property {object} value - Image Object. Contains image information.
+ * @example
     [
       {
         "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
@@ -432,7 +450,8 @@ interface IBodyTypeImageGroupOfImages {
  * @interface IBodyTypeFile
  * @property {string} marker - marker name. Example: "picture".
  * @property {'file'} type - Type value. Example: "file".
- * @property {object} value - File Object. Contains file information. Example:
+ * @property {object} value - File Object. Contains file information.
+ * @example
     [
       {
         "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
@@ -456,7 +475,8 @@ interface IBodyTypeFile {
  * @interface IBodyTypeRadioButtonList
  * @property {string} marker - marker name. Example: "selector".
  * @property {string} type - Type value. Example: 'list'.
- * @property {Array} value - Array of list or radioButton bojects. Example:
+ * @property {Array} value - Array of list or radioButton bojects.
+ * @example
     [
       {
         "title": "red",