oneentry 1.0.152 → 1.0.154

package/dist/discounts/discountsApi.d.ts

@@ -32,6 +32,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getAllDiscounts getAllDiscounts} documentation.
      */
     getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: IDiscountType): Promise<IDiscountsResponse | IError>;
     /**
@@ -42,6 +43,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches a discount by its marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountByMarker getDiscountByMarker} documentation.
      */
     getDiscountByMarker(marker: string, langCode?: string): Promise<IDiscountsEntity | IError>;
     /**
@@ -49,6 +51,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @handleName getBonusBalance
      * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusBalance getBonusBalance} documentation.
      */
     getBonusBalance(): Promise<IBonusBalanceEntity | IError>;
     /**
@@ -62,6 +65,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @param {boolean} [isAdmin] - Admin filter.
      * @returns {Promise<IBonusTransactionEntity[] | IError>} Returns array of bonus transactions or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusHistory getBonusHistory} documentation.
      */
     getBonusHistory(type?: IBonusTransactionType, dateFrom?: string, dateTo?: string, discountId?: number, moduleId?: number, isAdmin?: boolean): Promise<IBonusTransactionEntity[] | IError>;
     /**
@@ -71,6 +75,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function validates a coupon code and returns the result.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/validateDiscountsCoupon validateDiscountsCoupon} documentation.
      */
     validateDiscountsCoupon(code: string): Promise<ICouponValidationResult | IError>;
 }

package/dist/discounts/discountsApi.js

@@ -35,6 +35,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getAllDiscounts getAllDiscounts} documentation.
      */
     async getAllDiscounts(langCode = this.state.lang, offset = 0, limit = 30, type) {
         const query = {
@@ -54,6 +55,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches a discount by its marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountByMarker getDiscountByMarker} documentation.
      */
     async getDiscountByMarker(marker, langCode = this.state.lang) {
         const query = {
@@ -68,6 +70,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @handleName getBonusBalance
      * @returns {Promise<IBonusBalanceEntity | IError>} Returns bonus balance or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusBalance getBonusBalance} documentation.
      */
     async getBonusBalance() {
         const data = await this._fetchGet(`/bonus-balance`);
@@ -84,6 +87,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @param {boolean} [isAdmin] - Admin filter.
      * @returns {Promise<IBonusTransactionEntity[] | IError>} Returns array of bonus transactions or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusHistory getBonusHistory} documentation.
      */
     async getBonusHistory(type, dateFrom, dateTo, discountId, moduleId, isAdmin) {
         const query = {
@@ -104,6 +108,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function validates a coupon code and returns the result.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/validateDiscountsCoupon validateDiscountsCoupon} documentation.
      */
     async validateDiscountsCoupon(code) {
         const query = {

package/dist/events/eventsApi.d.ts

@@ -31,6 +31,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getAllSubscriptions getAllSubscriptions} documentation.
      */
     getAllSubscriptions(offset?: number, limit?: number): Promise<ISubscriptions | IError>;
     /**
@@ -43,6 +44,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/subscribeByMarker subscribeByMarker} documentation.
      */
     subscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
     /**
@@ -55,6 +57,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/unsubscribeByMarker unsubscribeByMarker} documentation.
      */
     unsubscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
     /**
@@ -63,6 +66,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @returns {Promise<IContentApiEvent[] | IError>} Returns an array of available events.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method returns all available events.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getAllEvents getAllEvents} documentation.
      */
     getAllEvents(): Promise<IContentApiEvent[] | IError>;
     /**
@@ -74,6 +78,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/subscribeToForm subscribeToForm} documentation.
      */
     subscribeToForm(marker: string, body: ISubscribeFormEvent): Promise<boolean | IError>;
     /**
@@ -85,6 +90,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getFormSubscriptions getFormSubscriptions} documentation.
      */
     getFormSubscriptions(offset?: number, limit?: number): Promise<IListFormSubscription[] | IError>;
     /**
@@ -96,6 +102,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/unsubscribeFromForm unsubscribeFromForm} documentation.
      */
     unsubscribeFromForm(marker: string, body: ISubscribeFormEvent): Promise<boolean | IError>;
 }

package/dist/events/eventsApi.js

@@ -36,6 +36,7 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getAllSubscriptions getAllSubscriptions} documentation.
      */
     async getAllSubscriptions(offset = 0, limit = 30) {
         const query = {
@@ -55,19 +56,14 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/subscribeByMarker subscribeByMarker} documentation.
      */
     async subscribeByMarker(marker, productId, langCode = this.state.lang) {
         const body = {
             locale: langCode,
             productId,
         };
-        try {
-            await this._fetchPost(`/subscribe/marker/${marker}`, body);
-            return true;
-        }
-        catch (e) {
-            return e;
-        }
+        return this._fetchBoolean(() => this._fetchPost(`/subscribe/marker/${marker}`, body));
     }
     /**
      * Unsubscribing to an event on a product.
@@ -79,19 +75,14 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/unsubscribeByMarker unsubscribeByMarker} documentation.
      */
     async unsubscribeByMarker(marker, productId, langCode = this.state.lang) {
         const body = {
             productId: productId,
             locale: langCode,
         };
-        try {
-            await this._fetchDelete(`/unsubscribe/marker/${marker}`, body);
-            return true;
-        }
-        catch (e) {
-            return e;
-        }
+        return this._fetchBoolean(() => this._fetchDelete(`/unsubscribe/marker/${marker}`, body));
     }
     /**
      * Returns all available events.
@@ -99,6 +90,7 @@ class EventsApi extends asyncModules_1.default {
      * @returns {Promise<IContentApiEvent[] | IError>} Returns an array of available events.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method returns all available events.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getAllEvents getAllEvents} documentation.
      */
     async getAllEvents() {
         const data = await this._fetchGet(`/all`);
@@ -113,15 +105,10 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/subscribeToForm subscribeToForm} documentation.
      */
     async subscribeToForm(marker, body) {
-        try {
-            await this._fetchPost(`/forms/subscribe/marker/${marker}`, body);
-            return true;
-        }
-        catch (e) {
-            return e;
-        }
+        return this._fetchBoolean(() => this._fetchPost(`/forms/subscribe/marker/${marker}`, body));
     }
     /**
      * Returns all form subscriptions.
@@ -132,6 +119,7 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/getFormSubscriptions getFormSubscriptions} documentation.
      */
     async getFormSubscriptions(offset = 0, limit = 30) {
         const query = {
@@ -150,15 +138,10 @@ class EventsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/events/unsubscribeFromForm unsubscribeFromForm} documentation.
      */
     async unsubscribeFromForm(marker, body) {
-        try {
-            await this._fetchDelete(`/forms/unsubscribe/marker/${marker}`, body);
-            return true;
-        }
-        catch (e) {
-            return e;
-        }
+        return this._fetchBoolean(() => this._fetchDelete(`/forms/unsubscribe/marker/${marker}`, body));
     }
 }
 exports.default = EventsApi;

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

@@ -43,6 +43,7 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {string | number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<IUploadingReturn[] | IError>} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/upload upload} documentation.
      */
     upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
     /**
@@ -63,6 +64,7 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<boolean | IError>} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/delete delete} documentation.
      */
     delete(filename: string, fileQuery?: IUploadingQuery): Promise<boolean | IError>;
     /**
@@ -80,9 +82,10 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {string} type - Type, determines the folder name in the storage. Example: "page".
      * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
      * @param {string} filename - Filename. Example: "file.png".
-     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @param {string} [template] - Preview template identifier. Example: "preview_template".
      * @returns {Promise<Response | IError>} Returns a promise that resolves to a Response object containing the file data or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/getFile getFile} documentation.
      */
     getFile(id: number, type: string, entity: string, filename: string, template?: string): Promise<Response | IError>;
 }

package/dist/file-uploading/fileUploadingApi.js

@@ -55,6 +55,7 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {string | number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<IUploadingReturn[] | IError>} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/upload upload} documentation.
      */
     async upload(file, fileQuery) {
         const query = { ...this._defaultQuery, ...fileQuery };
@@ -83,6 +84,7 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<boolean | IError>} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/delete delete} documentation.
      */
     async delete(filename, fileQuery) {
         const query = { ...this._defaultQuery, ...fileQuery };
@@ -110,9 +112,10 @@ class FileUploadingApi extends asyncModules_1.default {
      * @param {string} type - Type, determines the folder name in the storage. Example: "page".
      * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
      * @param {string} filename - Filename. Example: "file.png".
-     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @param {string} [template] - Preview template identifier. Example: "preview_template".
      * @returns {Promise<Response | IError>} Returns a promise that resolves to a Response object containing the file data or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/getFile getFile} documentation.
      */
     async getFile(id, type, entity, filename, template) {
         // eslint-disable-next-line no-undef

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

@@ -66,7 +66,7 @@ interface IFileUploading {
      * @param {string} type - Type, determines the folder name in the storage. Example: "page".
      * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
      * @param {string} filename - Filename. Example: "file.png".
-     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @param {string} [template] - Preview template identifier. Example: "1".
      * @returns {Response | IError} Returns a promise that resolves to a Response 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.
      */

package/dist/filters/filtersApi.d.ts

@@ -26,6 +26,7 @@ export default class FiltersApi extends AsyncModules implements IFiltersApi {
      * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Retrieves a single content filter by marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/filters/getFilterByMarker getFilterByMarker} documentation.
      */
     getFilterByMarker(marker: string, langCode?: string): Promise<IContentFilter | IError>;
 }

package/dist/filters/filtersApi.js

@@ -30,6 +30,7 @@ class FiltersApi extends asyncModules_1.default {
      * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Retrieves a single content filter by marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/filters/getFilterByMarker getFilterByMarker} documentation.
      */
     async getFilterByMarker(marker, langCode = this.state.lang) {
         const data = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

package/dist/forms/formsApi.d.ts

@@ -28,6 +28,7 @@ export default class FormsApi extends AsyncModules implements IForms {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {Promise<IFormsResponse | IError>} Returns paginated object with array of FormEntity and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getAllForms getAllForms} documentation.
      */
     getAllForms(langCode?: string, offset?: number, limit?: number): Promise<IFormsResponse | IError>;
     /**
@@ -37,6 +38,7 @@ export default class FormsApi extends AsyncModules implements IForms {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getFormByMarker getFormByMarker} documentation.
      */
     getFormByMarker(marker: string, langCode?: string): Promise<IFormsEntity | IError>;
 }

package/dist/forms/formsApi.js

@@ -32,6 +32,7 @@ class FormsApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {Promise<IFormsResponse | IError>} Returns paginated object with array of FormEntity and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getAllForms getAllForms} documentation.
      */
     async getAllForms(langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
@@ -46,6 +47,7 @@ class FormsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getFormByMarker getFormByMarker} documentation.
      */
     async getFormByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

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

@@ -56,6 +56,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPostFormResponse | IError>} Returns an object containing the created form data entry and message.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/postFormsData postFormsData} documentation.
      */
     postFormsData(body: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
     /**
@@ -79,6 +80,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {Promise<IFormsByMarkerDataEntity | IError>} Returns an object containing the form data or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/getFormsDataByMarker getFormsDataByMarker} documentation.
      */
     getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: object, isExtended?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsByMarkerDataEntity | IError>;
     /**
@@ -86,6 +88,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @handleName updateFormsDataByid
      * @param {number} id - ID of the form data. Example: 1.
      * @returns {Promise<IUpdateFormsData | IError>} Returns an object containing the updated form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/updateFormsDataByid updateFormsDataByid} documentation.
      */
     updateFormsDataByid(id: number, body?: object): Promise<IUpdateFormsData | IError>;
     /**
@@ -94,6 +97,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @param {number} id - ID of the form data. Example: 1.
      * @param {object} body - Request body.
      * @returns {Promise<boolean | IError>} Returns an object containing the updated form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/updateFormsDataStatusByid updateFormsDataStatusByid} documentation.
      */
     updateFormsDataStatusByid(id: number, body?: object): Promise<boolean | IError>;
     /**
@@ -101,6 +105,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @handleName deleteFormsDataByid
      * @param {number} id - ID of the form data. Example: 1.
      * @returns {Promise<boolean | IError>} Returns an object containing the deleted form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/deleteFormsDataByid deleteFormsDataByid} documentation.
      */
     deleteFormsDataByid(id: number): Promise<boolean | IError>;
 }

package/dist/forms-data/formsDataApi.js

@@ -62,6 +62,7 @@ class FormsDataApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IPostFormResponse | IError>} Returns an object containing the created form data entry and message.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/postFormsData postFormsData} documentation.
      */
     async postFormsData(body, langCode = this.state.lang) {
         const formData = {};
@@ -145,6 +146,7 @@ class FormsDataApi extends asyncModules_1.default {
      * @param {number} [limit] - Parameter for pagination. Default: 30.
      * @returns {Promise<IFormsByMarkerDataEntity | IError>} Returns an object containing the form data or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/getFormsDataByMarker getFormsDataByMarker} documentation.
      */
     async getFormsDataByMarker(marker, formModuleConfigId, body = {}, isExtended = 0, langCode = this.state.lang, offset = 0, limit = 30) {
         const result = await this._fetchPost(`/marker/${marker}?formModuleConfigId=${formModuleConfigId}&isExtended=${isExtended}&langCode=${langCode}&offset=${offset}&limit=${limit}`, body);
@@ -157,6 +159,7 @@ class FormsDataApi extends asyncModules_1.default {
      * @handleName updateFormsDataByid
      * @param {number} id - ID of the form data. Example: 1.
      * @returns {Promise<IUpdateFormsData | IError>} Returns an object containing the updated form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/updateFormsDataByid updateFormsDataByid} documentation.
      */
     async updateFormsDataByid(id, body = {}) {
         const result = await this._fetchPut(`/${id}`, body);
@@ -170,6 +173,7 @@ class FormsDataApi extends asyncModules_1.default {
      * @param {number} id - ID of the form data. Example: 1.
      * @param {object} body - Request body.
      * @returns {Promise<boolean | IError>} Returns an object containing the updated form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/updateFormsDataStatusByid updateFormsDataStatusByid} documentation.
      */
     async updateFormsDataStatusByid(id, body = {}) {
         const result = await this._fetchPut(`/${id}/update-status`, body);
@@ -180,6 +184,7 @@ class FormsDataApi extends asyncModules_1.default {
      * @handleName deleteFormsDataByid
      * @param {number} id - ID of the form data. Example: 1.
      * @returns {Promise<boolean | IError>} Returns an object containing the deleted form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/deleteFormsDataByid deleteFormsDataByid} documentation.
      */
     async deleteFormsDataByid(id) {
         const result = await this._fetchDelete(`/${id}`);

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

@@ -23,6 +23,7 @@ export default class GeneralTypesApi extends AsyncModules implements IGeneralTyp
      * @returns {Promise<IGeneralTypesEntity[] | IError>} Returns an array of general types or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method retrieves all general types available in the system.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/general-types/getAllTypes getAllTypes} documentation.
      */
     getAllTypes(): Promise<IGeneralTypesEntity[] | IError>;
 }

package/dist/general-types/generalTypesApi.js

@@ -27,6 +27,7 @@ class GeneralTypesApi extends asyncModules_1.default {
      * @returns {Promise<IGeneralTypesEntity[] | IError>} Returns an array of general types or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method retrieves all general types available in the system.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/general-types/getAllTypes getAllTypes} documentation.
      */
     async getAllTypes() {
         const result = await this._fetchGet('');

package/dist/index.js

@@ -53,6 +53,18 @@ const wsApi_1 = __importDefault(require("./web-socket/wsApi"));
  * @description Define API.
  */
 function defineOneEntry(url, config) {
+    if (typeof url !== 'string' || url.trim() === '') {
+        throw new Error('OneEntry SDK: project URL is required to initialize the SDK. ' +
+            'Pass a non-empty URL as the first argument of defineOneEntry, e.g. ' +
+            'defineOneEntry("https://your-project.oneentry.cloud", { token: "your-app-token" }).');
+    }
+    if (!config ||
+        typeof config.token !== 'string' ||
+        config.token.trim() === '') {
+        throw new Error('OneEntry SDK: app token is required to initialize the SDK. ' +
+            'Pass it via config, e.g. ' +
+            'defineOneEntry("https://your-project.oneentry.cloud", { token: "your-app-token" }).');
+    }
     const stateModule = new stateModule_1.default(url.endsWith('/') ? url.slice(0, -1) : url, config);
     const Admins = new adminsApi_1.default(stateModule);
     const AttributesSets = new attributeSetsApi_1.default(stateModule);

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

@@ -35,6 +35,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
      * @returns {Promise<ICollectionEntity[] | IError>} Returns an array of ICollection objects or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollections getICollections} documentation.
      */
     getICollections(langCode?: string, userQuery?: ICollectionQuery): Promise<ICollectionEntity[] | IError>;
     /**
@@ -44,6 +45,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ICollectionEntity | IError>} Returns an ICollection object or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionById getICollectionById} documentation.
      */
     getICollectionById(id: number, langCode?: string): Promise<ICollectionEntity | IError>;
     /**
@@ -61,11 +63,12 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
         }
      * @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: "orders".
+     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
      * @returns {Promise<ICollectionRowsResponce | IError>} Returns object ItemsWithTotal, where items is an array of requested objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all records belonging to the collection by collection id.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowsById getICollectionRowsById} documentation.
      */
     getICollectionRowsById(id: number, langCode?: string, userQuery?: ICollectionQuery): Promise<ICollectionRowsResponce | IError>;
     /**
@@ -79,6 +82,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
         }
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Check for the existence of a text identifier (marker).
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/validateICollectionMarker validateICollectionMarker} documentation.
      */
     validateICollectionMarker(marker: string): Promise<ICollectionIsValid | IError>;
     /**
@@ -88,6 +92,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ICollectionRowsResponce | IError>} Returns CollectionRowEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowsByMarker getICollectionRowsByMarker} documentation.
      */
     getICollectionRowsByMarker(marker: string, langCode?: string): Promise<ICollectionRowsResponce | IError>;
     /**
@@ -98,6 +103,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ICollectionRow | IError>} Returns CollectionRowEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollectionRowByMarkerAndId getICollectionRowByMarkerAndId} documentation.
      */
     getICollectionRowByMarkerAndId(marker: string, id: number, langCode?: string): Promise<ICollectionRow | IError>;
     /**
@@ -120,6 +126,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Create a record in the collection.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/createICollectionRow createICollectionRow} documentation.
      */
     createICollectionRow(marker: string, body: ICollectionFormObject, langCode?: string): Promise<ICollectionRow | IError>;
     /**
@@ -145,6 +152,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @returns {Promise<ICollectionRow | IError>} Returns object of type ICollectionRow.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Edit a record in the collection.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/updateICollectionRow updateICollectionRow} documentation.
      */
     updateICollectionRow(marker: string, id: number, body: {
         formIdentifier: string;
@@ -158,6 +166,7 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @returns {Promise<boolean | IError>} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Deletion of collection record object
+     * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/deleteICollectionRowByMarkerAndId deleteICollectionRowByMarkerAndId} documentation.
      */
     deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<boolean | IError>;
 }