oneentry 1.0.126 → 1.0.127

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

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

package/dist/general-types/generalTypesApi.js

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

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

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

package/dist/index.d.ts

@@ -54,19 +54,18 @@ interface IDefineApi {
 }
 /**
  * Define API.
- *
- * @function
- * @param {string} url - URl of your project.
- * @param {IConfig} config - Custom configuration settings
- * @param {string} [config.token] - Optional token parameter
- * @param {string} [config.langCode] - Optional langCode parameter
- * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
- * @param {string} [config.auth] - An object with authorization settings.
- * @param {boolean} [config.auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
- * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
- * @param {string} [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
- *
- * @return List of methods set.
+ * @function defineOneEntry
+ * @param   {string}     url                        - URl of your project.
+ * @param   {IConfig}    config                     - Custom configuration settings
+ * @param   {string}     [config.token]             - Optional token parameter
+ * @param   {string}     [config.langCode]          - Optional langCode parameter
+ * @param   {boolean}    [config.traficLimit]       - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @param   {string}     [config.auth]              - An object with authorization settings.
+ * @param   {boolean}    [config.auth.customAuth]   - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
+ * @param   {string}     [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
+ * @param   {string}     [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
+ * @returns {IDefineApi}                            List of methods set.
+ * @description Define API.
  */
 export declare function defineOneEntry(url: string, config: IConfig): IDefineApi;
 export {};

package/dist/index.js

@@ -32,19 +32,18 @@ const usersApi_1 = __importDefault(require("./users/usersApi"));
 const wsApi_1 = __importDefault(require("./web-socket/wsApi"));
 /**
  * Define API.
- *
- * @function
- * @param {string} url - URl of your project.
- * @param {IConfig} config - Custom configuration settings
- * @param {string} [config.token] - Optional token parameter
- * @param {string} [config.langCode] - Optional langCode parameter
- * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
- * @param {string} [config.auth] - An object with authorization settings.
- * @param {boolean} [config.auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
- * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
- * @param {string} [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
- *
- * @return List of methods set.
+ * @function defineOneEntry
+ * @param   {string}     url                        - URl of your project.
+ * @param   {IConfig}    config                     - Custom configuration settings
+ * @param   {string}     [config.token]             - Optional token parameter
+ * @param   {string}     [config.langCode]          - Optional langCode parameter
+ * @param   {boolean}    [config.traficLimit]       - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @param   {string}     [config.auth]              - An object with authorization settings.
+ * @param   {boolean}    [config.auth.customAuth]   - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
+ * @param   {string}     [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
+ * @param   {string}     [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
+ * @returns {IDefineApi}                            List of methods set.
+ * @description Define API.
  */
 function defineOneEntry(url, config) {
     const stateModule = new stateModule_1.default(url.endsWith('/') ? url.slice(0, -1) : url, config);

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

@@ -4,36 +4,36 @@ import type { IError } from '../base/utils';
 import type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionRow, ICollectionRowsResponce, ICollectionsApi } from './integrationCollectionsInterfaces';
 /**
  * Controllers for working with attributes.
- *
  * @handle /api/content/integration-collections
  * @class IntegrationCollectionsApi
- * @extends AsyncModules
+ * @augments AsyncModules
  * @implements {ICollectionsApi}
  * @description This class provides methods to interact with integration collections, including retrieving all collections, getting a single collection by ID, and managing collection rows.
  */
 export default class IntegrationCollectionsApi extends AsyncModules implements ICollectionsApi {
     protected state: StateModule;
     protected _url: string;
+    /**
+     *
+     */
     constructor(state: StateModule);
     private _defaultQuery;
     /**
      * Get all collections.
-     *
      * @handleName getICollections
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {object} [userQuery] - Optional set query parameters. Example:
-        {
-          "limit": 0,
-          "offset": 30,
-          "entityType": "orders",
-          "entityId": 1
-        }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
-     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @return {ICollectionEntity[]} Returns an array of ICollection objects or an error object if there was an issue.
+     * @param   {string}              [langCode]             - Language code. Default: "en_US".
+     * @param   {object}              [userQuery]            - Optional set query parameters. Example:
+                                                             {
+                                                             "limit": 0,
+                                                             "offset": 30,
+                                                             "entityType": "orders",
+                                                             "entityId": 1
+                                                             }
+     * @param   {number}              [userQuery.limit]      - Optional parameter for pagination. Default: 0.
+     * @param   {number}              [userQuery.offset]     - Optional parameter for pagination. Default: 30.
+     * @param   {string}              [userQuery.entityType] - Entity type. Example: "orders".
+     * @param   {number}              [userQuery.entityId]   - Entity identifier. Example: 1.
+     * @returns {ICollectionEntity[]}                        Returns an array of ICollection objects or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @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.
      */
@@ -45,35 +45,31 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     }): Promise<ICollectionEntity[] | IError>;
     /**
      * Get a single collection object by id.
-     *
      * @handleName getICollectionById
-     *
-     * @param {number} id - Collection id. Example: 1.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionEntity} Returns an ICollection object or an error object if there was an issue.
+     * @param   {number}            id         - Collection id. Example: 1.
+     * @param   {string}            [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionEntity}            Returns an ICollection object or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getICollectionById(id: number, langCode?: string): Promise<ICollectionEntity | IError>;
     /**
      * Get all records belonging to the collection by collection id.
-     *
      * @handleName getICollectionRowsById
-     *
-     * @param {number} id - Collection id. Example: 1.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters. Example:
-        {
-          "limit": 0,
-          "offset": 30,
-          "entityType": "orders",
-          "entityId": 1
-        }
-     * @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 {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @return {ICollectionRowsResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @param   {number}                  id                     - Collection id. Example: 1.
+     * @param   {string}                  [langCode]             - Language code. Default: "en_US".
+     * @param   {any}                     [userQuery]            - Optional set query parameters. Example:
+                                                                 {
+                                                                 "limit": 0,
+                                                                 "offset": 30,
+                                                                 "entityType": "orders",
+                                                                 "entityId": 1
+                                                                 }
+     * @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   {number}                  [userQuery.entityId]   - Entity identifier. Example: 1.
+     * @returns {ICollectionRowsResponce}                        Returns object ItemsWithTotal, where items is an array of requested objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Get all records belonging to the collection by collection id.
      */
@@ -85,90 +81,82 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     }): Promise<ICollectionRowsResponce | IError>;
     /**
      * Check for the existence of a text identifier (marker).
-     *
      * @handleName validateICollectionMarker
-     *
-     * @param {string} marker - Collection marker. Example: "collection1".
-     * @return {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
-        {
-          "valid": true
-        }
+     * @param   {string}             marker - Collection marker. Example: "collection1".
+     * @returns {ICollectionIsValid}        Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
+                                            {
+                                            "valid": true
+                                            }
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Check for the existence of a text identifier (marker).
      */
     validateICollectionMarker(marker: string): Promise<ICollectionIsValid | IError>;
     /**
      * Getting all records from the collection.
-     *
      * @handleName getICollectionRowsByMarker
-     *
-     * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRowsResponce} Returns CollectionRowEntity object.
+     * @param   {string}                  marker     - Collection text identifier. Example: "collection1".
+     * @param   {string}                  [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionRowsResponce}            Returns CollectionRowEntity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getICollectionRowsByMarker(marker: string, langCode?: string): Promise<ICollectionRowsResponce | IError>;
     /**
      * Getting one record from the collection.
-     *
      * @handleName getICollectionRowByMarkerAndId
-     *
-     * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {number} id - Collection record identifier. Example: 1.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRow} Returns CollectionRowEntity object.
+     * @param   {string}         marker     - Collection text identifier. Example: "collection1".
+     * @param   {number}         id         - Collection record identifier. Example: 1.
+     * @param   {string}         [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionRow}            Returns CollectionRowEntity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getICollectionRowByMarkerAndId(marker: string, id: number, langCode?: string): Promise<ICollectionRow | IError>;
     /**
      * Create a record in the collection.
-     *
      * @handleName createICollectionRow
-     *
-     * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {ICollectionFormObject} body - Object for creating a record. Example:
-        {
-          "formIdentifier": "collection-form",
-          "formData": {
-            "en_US": [
-              {
-                "marker": "collection_marker",
-                "type": "string",
-                "value": "Collection marker"
-              }
-            ]
-          }
-        }
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRow} Returns object of type ICollectionRow.
+     * @param   {string}                marker     - Collection text identifier. Example: "collection1".
+     * @param   {ICollectionFormObject} body       - Object for creating a record. Example:
+                                                   {
+                                                   "formIdentifier": "collection-form",
+                                                   "formData": {
+                                                   "en_US": [
+                                                   {
+                                                   "marker": "collection_marker",
+                                                   "type": "string",
+                                                   "value": "Collection marker"
+                                                   }
+                                                   ]
+                                                   }
+                                                   }
+     * @param   {string}                [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionRow}                   Returns object of type ICollectionRow.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Create a record in the collection.
      */
     createICollectionRow(marker: string, body: ICollectionFormObject, langCode?: string): Promise<ICollectionRow | IError>;
     /**
      * Edit a record in the collection.
-     *
      * @handleName updateICollectionRow
-     *
-     * @param {string} marker - Text identifier of the collection. Example: "collection1".
-     * @param {number} id - Row identifier in the collection. Example: 12.
-     * @param {object} body - Object for updating a record in the collection. Example:
-        {
-          "formIdentifier": "collection-form",
-          "formData": {
-            "en_US": [
-              {
-                "marker": "collection_marker",
-                "type": "string",
-                "value": "Collection marker"
-              }
-            ]
-          }
-        }
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRow} Returns object of type ICollectionRow.
+     * @param   {string}         marker              - Text identifier of the collection. Example: "collection1".
+     * @param   {number}         id                  - Row identifier in the collection. Example: 12.
+     * @param   {object}         body                - Object for updating a record in the collection. Example:
+                                                     {
+                                                     "formIdentifier": "collection-form",
+                                                     "formData": {
+                                                     "en_US": [
+                                                     {
+                                                     "marker": "collection_marker",
+                                                     "type": "string",
+                                                     "value": "Collection marker"
+                                                     }
+                                                     ]
+                                                     }
+                                                     }
+     * @param   {string}         body.formIdentifier - Textual identifier of the form. Example: "collection-form".
+     * @param   {any}            body.formData       - Object with the form data.
+     * @param   {string}         [langCode]          - Language code. Default: "en_US".
+     * @returns {ICollectionRow}                     Returns object of type ICollectionRow.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Edit a record in the collection.
      */
@@ -178,12 +166,10 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
     }, langCode?: string): Promise<ICollectionRow | IError>;
     /**
      * Deletion of collection record object
-     *
      * @handleName deleteICollectionRowByMarkerAndId
-     *
-     * @param {string} marker - text identifier of the collection Example: "collection1".
-     * @param {number} id - record identifier in the collection Example: 12.
-     * @return {boolean} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @param   {string}  marker - text identifier of the collection Example: "collection1".
+     * @param   {number}  id     - record identifier in the collection Example: 12.
+     * @returns {boolean}        Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Deletion of collection record object
      */