oneentry 1.0.126 → 1.0.127

package/dist/integration-collections/integrationCollectionsApi.js

@@ -3,17 +3,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable jsdoc/reject-any-type */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * 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.
  */
 class IntegrationCollectionsApi extends asyncModules_1.default {
+    /**
+     *
+     */
     constructor(state) {
         super(state);
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -26,28 +29,24 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * 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.
      */
-    async getICollections(langCode = this.state.lang, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    userQuery) {
+    async getICollections(langCode = this.state.lang, userQuery) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const query = { ...this._defaultQuery, ...userQuery, langCode };
         const result = await this._fetchGet(`?` + this._queryParamsToString(query));
@@ -55,39 +54,34 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * 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.
      */
     async getICollectionById(id, langCode = this.state.lang) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const result = await this._fetchGet(`/${id}?` + this._queryParamsToString({ langCode }));
         return this._dataPostProcess(result, langCode);
     }
     /**
      * 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.
      */
@@ -102,14 +96,12 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * 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).
      */
@@ -119,12 +111,10 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * 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.
      */
@@ -134,13 +124,11 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * 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.
      */
@@ -150,25 +138,23 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * 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.
      */
@@ -178,26 +164,26 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * 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.
      */
@@ -207,12 +193,10 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * 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
      */