oneentry 1.0.126 → 1.0.128

package/README.md

@@ -192,7 +192,6 @@ Now you can use the following links to jump to specific entries documentation:
 - [Forms](https://js-sdk.oneentry.cloud/docs/category/forms-1)
 - [FormData](https://js-sdk.oneentry.cloud/docs/category/formdata)
 - [GeneralTypes](https://js-sdk.oneentry.cloud/docs/category/generaltypes)
-- [ImmutableSettings](https://js-sdk.oneentry.cloud/docs/category/immutablesettings)
 - [IntegrationCollections](https://js-sdk.oneentry.cloud/docs/category/integrationcollections)
 - [Locales](https://js-sdk.oneentry.cloud/docs/category/locales)
 - [Menus](https://js-sdk.oneentry.cloud/docs/category/menus)
@@ -201,7 +200,6 @@ Now you can use the following links to jump to specific entries documentation:
 - [Payments](https://js-sdk.oneentry.cloud/docs/category/payments)
 - [ProductStatuses](https://js-sdk.oneentry.cloud/docs/category/productstatuses)
 - [Products](https://js-sdk.oneentry.cloud/docs/category/products-1)
-- [Settings](https://js-sdk.oneentry.cloud/docs/category/settings)
 - [System](https://js-sdk.oneentry.cloud/docs/category/system)
 - [Templates](https://js-sdk.oneentry.cloud/docs/category/templates)
 - [TemplatePreviews](https://js-sdk.oneentry.cloud/docs/category/templatepreviews)

package/configure.js

@@ -1,26 +1,32 @@
-#!/usr/bin/env node
+/* eslint-disable no-undef */
+/* eslint-disable @typescript-eslint/no-require-imports */
 
 const fs = require('fs');
-const path = require('path');
+// const path = require('path');
 
 const readline = require('readline');
 
 const rl = readline.createInterface({
   input: process.stdin,
-  output: process.stdout
+  output: process.stdout,
 });
 
-rl.question('Enter project name witht https://... : ', (name) => {
+rl.question('Enter project name with https://... : ', (name) => {
   rl.question('Enter token: ', (token) => {
-    rl.close()
-    createInterface(name, token)
-  })
-})
-
+    rl.close();
+    createInterface(name, token);
+  });
+});
 
+/**
+ * Create interface
+ * @param {*} name name
+ * @param {*} token token
+ */
 function createInterface(name, token) {
-  const filePath = 'example.ts'
-  fs.writeFile(filePath,
+  const filePath = 'example.ts';
+  fs.writeFile(
+    filePath,
     `
       type BuildInterface<T extends string[]> = {
           [K in T[number]]: string | undefined;
@@ -30,11 +36,12 @@ function createInterface(name, token) {
           IAttributesList
       }
     `,
-  (err) => {
-    if (err) {
-      console.error(err);
-      return;
-    }
-    console.log(`Successfully created ${filePath}`);
-  })
+    (err) => {
+      if (err) {
+        console.error(err);
+        return;
+      }
+      console.log(`Successfully created ${filePath}`);
+    },
+  );
 }

package/dist/admins/adminsApi.d.ts

@@ -4,21 +4,26 @@ import type { AttributeType, IError } from '../base/utils';
 import type { IAdminEntity, IAdmins } from './adminsInterfaces';
 /**
  * Controllers for working with users - admins.
- *
- * @module AdminsApi
- *
+ * @class AdminsApi
+ * @augments AsyncModules
+ * @implements {IAdmins}
  * @description This module provides methods for working with users - admins, including retrieving information about all admins.
  */
 export default class AdminsApi extends AsyncModules implements IAdmins {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Initializes the AdminsApi with the provided state module.
+     * @class
+     * @class AdminsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the AdminsApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * Get all admins objects with filters.
-     *
      * @handleName getAdminsInfo
-     *
-     * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: []. Example:
+     * @param {AttributeType[]} body - Array of filter objects with search conditions. Default: []. Example:
         [
           {
             "attributeMarker": "num",
@@ -31,13 +36,13 @@ export default class AdminsApi extends AsyncModules implements IAdmins {
             "conditionValue": 3
           }
         ]
-     * @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
-     * @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
-     * @param {string} [body.conditionValue] - Value of the condition. Example: 1.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @return {IAdminEntity[]} Returns an array of admin objects.
+     * @param {string} body.attributeMarker - Text identifier (marker) of the attribute in the set. Example: "num".
+     * @param {string} body.conditionMarker - Text identifier (marker) of the condition in the set. Example: "mth".
+     * @param {string} body.conditionValue - Value of the condition. Example: 1.
+     * @param {string} langCode - Language code. Default: "en_US".
+     * @param {number} offset - Parameter for pagination. Default: 0.
+     * @param {number} limit - Parameter for pagination. Default: 30.
+     * @returns {IAdminEntity[]} Returns an array of admin objects.
      * @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.
      */

package/dist/admins/adminsApi.js

@@ -6,22 +6,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with users - admins.
- *
- * @module AdminsApi
- *
+ * @class AdminsApi
+ * @augments AsyncModules
+ * @implements {IAdmins}
  * @description This module provides methods for working with users - admins, including retrieving information about all admins.
  */
 class AdminsApi extends asyncModules_1.default {
+    /**
+     * Initializes the AdminsApi with the provided state module.
+     * @class
+     * @class AdminsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the AdminsApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/admins/all';
     }
     /**
      * Get all admins objects with filters.
-     *
      * @handleName getAdminsInfo
-     *
-     * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: []. Example:
+     * @param {AttributeType[]} body - Array of filter objects with search conditions. Default: []. Example:
         [
           {
             "attributeMarker": "num",
@@ -34,13 +39,13 @@ class AdminsApi extends asyncModules_1.default {
             "conditionValue": 3
           }
         ]
-     * @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
-     * @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
-     * @param {string} [body.conditionValue] - Value of the condition. Example: 1.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @return {IAdminEntity[]} Returns an array of admin objects.
+     * @param {string} body.attributeMarker - Text identifier (marker) of the attribute in the set. Example: "num".
+     * @param {string} body.conditionMarker - Text identifier (marker) of the condition in the set. Example: "mth".
+     * @param {string} body.conditionValue - Value of the condition. Example: 1.
+     * @param {string} langCode - Language code. Default: "en_US".
+     * @param {number} offset - Parameter for pagination. Default: 0.
+     * @param {number} limit - Parameter for pagination. Default: 30.
+     * @returns {IAdminEntity[]} Returns an array of admin objects.
      * @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.
      */

package/dist/admins/adminsInterfaces.d.ts

@@ -1,36 +1,33 @@
 import type { AttributeType, IAttributeValues, IError } from '../base/utils';
 /**
  * @interface IAdmins
- *
- * @property {function} getAdminsInfo - Method to retrieve all admin user objects.
+ * @property {Function} getAdminsInfo - Method to retrieve all admin user objects.
  * @description This interface defines the contract for any class that implements it
  */
 interface IAdmins {
     /**
      * Get all admins objects with filters.
-     *
      * @handleName getAdminsInfo
-     *
      * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: []. Example:
-        [
-          {
-            "attributeMarker": "num",
-            "conditionMarker": "mth",
-            "conditionValue": 1
-          },
-          {
-            "attributeMarker": "num",
-            "conditionMarker": "lth",
-            "conditionValue": 3
-          }
-        ]
+       [
+       {
+       "attributeMarker": "num",
+       "conditionMarker": "mth",
+       "conditionValue": 1
+       },
+       {
+       "attributeMarker": "num",
+       "conditionMarker": "lth",
+       "conditionValue": 3
+       }
+       ]
      * @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
      * @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
      * @param {string} [body.conditionValue] - Value of the condition. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @return {IAdminEntity[]} Returns an array of admin objects.
+     * @returns {IAdminEntity[]} Returns an array of admin objects.
      * @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.
      */
@@ -38,9 +35,7 @@ interface IAdmins {
 }
 /**
  * Interface representing a Position entity.
- *
  * @interface IPosition
- *
  * @property {number} id - The unique identifier of the position. Example: 1764.
  * @property {boolean} [isLocked] - Indicates whether the position is locked or not. Example: false.
  * @property {number} objectId - The unique identifier of the object. Example: 120.
@@ -59,10 +54,8 @@ interface IPosition {
 }
 /**
  * Interface representing an Admin Entity.
- *
  * @interface IAdminEntity
- *
- * @property {number} id - The identifier of the object. Example: 1764.
+ * @property {number | null} id - The identifier of the object. Example: 1764.
  * @property {number | null} attributeSetId - The identifier of the attribute set being used. Example: 120.
  * @property {string} identifier - The textual identifier for the record field. Example: "admin1".
  * @property {string | null} attributeSetIdentifier - The identifier of the attribute set. Example: "admins".
@@ -91,10 +84,8 @@ interface IAdminEntity {
 }
 /**
  * Interface representing a query for fetching admin data.
- *
  * @interface IAdminQuery
- *
- * @property {number} langCode - Language code. Default: "en_US".
+ * @property {string} langCode - Language code. Default: "en_US".
  * @property {number} limit - Parameter for pagination. Default: 30.
  * @property {number} offset - Parameter for pagination. Default: 0.
  * @description This interface defines the parameters required for querying admin data, including optional defaults.

package/dist/attribute-sets/attributeSetsApi.d.ts

@@ -4,63 +4,62 @@ import type { IError } from '../base/utils';
 import type { IAttributeSetsEntity, IAttributesSets, IAttributesSetsEntity, IAttributesSetsResponse } from './attributeSetsInterfaces';
 /**
  * Controllers for working with attributes - AttributesSetsApi.
- *
- * @module AttributesSetsApi
- *
+ * @class AttributesSetsApi
+ * @augments AsyncModules
+ * @implements {IAttributesSets}
  * @description This class provides methods to interact with attribute sets, including fetching attributes, getting attributes by marker, and retrieving single attributes by marker and set.
  */
 export default class AttributesSetsApi extends AsyncModules implements IAttributesSets {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Initializes the AttributesSetsApi with the provided state module.
+     * @class
+     * @class AttributesSetsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the AttributesSetsApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * Getting all attribute sets objects.
-     *
      * @handleName getAttributes
-     *
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - parameter offset of record selection. Default: 0.
      * @param {number} [limit] - parameter limiting the selection of records. Default: 30.
      * @param {number} [typeId] - identifier of the attribute set type. Default: null.
      * @param {string} [sortBy] - identifier of the attribute set type. Default: "id".
-     * @return {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
+     * @returns {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
      * @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.
      */
     getAttributes(langCode?: string, offset?: number, limit?: number, typeId?: any, sortBy?: string): Promise<IAttributesSetsResponse | IError>;
     /**
      * Getting all attributes with data from the attribute set.
-     *
      * @handleName getAttributesByMarker
-     *
      * @param {string} marker - Attribute marker. Example: "productAttributes".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IAttributeSetsEntity[]} Returns an array of Attributes objects.
+     * @returns {IAttributeSetsEntity[]} Returns an array of Attributes objects.
      * @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.
      */
     getAttributesByMarker(marker: string, langCode?: string): Promise<IAttributeSetsEntity[] | IError>;
     /**
      * Get a single attribute with data from the attribute sets.
-     *
      * @handleName getSingleAttributeByMarkerSet
-     *
      * @param {string} setMarker - Text identifier (marker) of the attribute set. Example: "productAttributes".
      * @param {string} attributeMarker - Text identifier (marker) of the attribute in the set. Example: "color".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
+     * @returns {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
      * @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.
      */
     getSingleAttributeByMarkerSet(setMarker: string, attributeMarker: string, langCode?: string): Promise<IAttributesSetsEntity | IError>;
     /**
      * Getting a single object from a set of attributes by marker.
-     *
      * @handleName getAttributeSetByMarker
-     *
      * @param {string} marker - marker of the attribute set object. Example: "productAttributes".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IAttributeSetsEntity} Returns one object of the attribute set.
+     * @returns {IAttributeSetsEntity} Returns one object of the attribute set.
      * @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.
      */

package/dist/attribute-sets/attributeSetsApi.js

@@ -6,27 +6,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with attributes - AttributesSetsApi.
- *
- * @module AttributesSetsApi
- *
+ * @class AttributesSetsApi
+ * @augments AsyncModules
+ * @implements {IAttributesSets}
  * @description This class provides methods to interact with attribute sets, including fetching attributes, getting attributes by marker, and retrieving single attributes by marker and set.
  */
 class AttributesSetsApi extends asyncModules_1.default {
+    /**
+     * Initializes the AttributesSetsApi with the provided state module.
+     * @class
+     * @class AttributesSetsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the AttributesSetsApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/attributes-sets';
     }
     /**
      * Getting all attribute sets objects.
-     *
      * @handleName getAttributes
-     *
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - parameter offset of record selection. Default: 0.
      * @param {number} [limit] - parameter limiting the selection of records. Default: 30.
      * @param {number} [typeId] - identifier of the attribute set type. Default: null.
      * @param {string} [sortBy] - identifier of the attribute set type. Default: "id".
-     * @return {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
+     * @returns {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
      * @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.
      */
@@ -46,12 +51,10 @@ class AttributesSetsApi extends asyncModules_1.default {
     }
     /**
      * Getting all attributes with data from the attribute set.
-     *
      * @handleName getAttributesByMarker
-     *
      * @param {string} marker - Attribute marker. Example: "productAttributes".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IAttributeSetsEntity[]} Returns an array of Attributes objects.
+     * @returns {IAttributeSetsEntity[]} Returns an array of Attributes objects.
      * @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.
      */
@@ -61,13 +64,11 @@ class AttributesSetsApi extends asyncModules_1.default {
     }
     /**
      * Get a single attribute with data from the attribute sets.
-     *
      * @handleName getSingleAttributeByMarkerSet
-     *
      * @param {string} setMarker - Text identifier (marker) of the attribute set. Example: "productAttributes".
      * @param {string} attributeMarker - Text identifier (marker) of the attribute in the set. Example: "color".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
+     * @returns {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
      * @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.
      */
@@ -77,12 +78,10 @@ class AttributesSetsApi extends asyncModules_1.default {
     }
     /**
      * Getting a single object from a set of attributes by marker.
-     *
      * @handleName getAttributeSetByMarker
-     *
      * @param {string} marker - marker of the attribute set object. Example: "productAttributes".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IAttributeSetsEntity} Returns one object of the attribute set.
+     * @returns {IAttributeSetsEntity} Returns one object of the attribute set.
      * @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.
      */