oneentry 1.0.124 → 1.0.126

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

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { ICollection, ICollectionFormObject, ICollectionResponce, ICollectionRow, ICollectionsApi } from './integrationCollectionsInterfaces';
+import type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionRow, ICollectionRowsResponce, ICollectionsApi } from './integrationCollectionsInterfaces';
 /**
  * Controllers for working with attributes.
  *
@@ -9,7 +9,6 @@ import type { ICollection, ICollectionFormObject, ICollectionResponce, ICollecti
  * @class IntegrationCollectionsApi
  * @extends 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 {
@@ -23,18 +22,27 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @handleName getICollections
      *
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters.
+     * @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 {number} [userQuery.entityType] - Entity type. Example: 1.
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: orders.
-     *
-     * @return {ICollection[]} Returns an array of ICollection objects or an error object if there was an issue.
+     * @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.
      * @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.
      */
-    getICollections(langCode?: string, userQuery?: any): Promise<Array<ICollection> | IError>;
+    getICollections(langCode?: string, userQuery?: {
+        limit: number;
+        offset: number;
+        entityType: string;
+        entityId: number;
+    }): Promise<ICollectionEntity[] | IError>;
     /**
      * Get a single collection object by id.
      *
@@ -42,13 +50,11 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      *
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
-     * @return {ICollection} Returns an ICollection object or an error object if there was an issue.
+     * @return {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<ICollection | IError>;
+    getICollectionById(id: number, langCode?: string): Promise<ICollectionEntity | IError>;
     /**
      * Get all records belonging to the collection by collection id.
      *
@@ -56,34 +62,41 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      *
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters. Example: .
-     *
+     * @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: 1.
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: "orders".
-     *
-     * @return {ICollectionResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @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.
      * @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.
      */
-    getICollectionRowsById(id: number, langCode?: string, userQuery?: any): Promise<ICollectionResponce | IError>;
+    getICollectionRowsById(id: number, langCode?: string, userQuery?: {
+        limit: number;
+        offset: number;
+        entityType: string;
+        entityId: number;
+    }): Promise<ICollectionRowsResponce | IError>;
     /**
      * Check for the existence of a text identifier (marker).
      *
      * @handleName validateICollectionMarker
      *
      * @param {string} marker - Collection marker. Example: "collection1".
-     *
-     * @return {any} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @return {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
+     * @description Check for the existence of a text identifier (marker).
      */
-    validateICollectionMarker(marker: string): Promise<{
-        valid: boolean;
-    } | IError>;
+    validateICollectionMarker(marker: string): Promise<ICollectionIsValid | IError>;
     /**
      * Getting all records from the collection.
      *
@@ -91,13 +104,11 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      *
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
-     * @return {any} Returns CollectionRowEntity object.
+     * @return {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<any | IError>;
+    getICollectionRowsByMarker(marker: string, langCode?: string): Promise<ICollectionRowsResponce | IError>;
     /**
      * Getting one record from the collection.
      *
@@ -106,28 +117,36 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @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 {any} Returns CollectionRowEntity object.
+     * @return {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<any | IError>;
+    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 {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 {any} Returns object of type ICollectionRow.
+     * @return {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<any | IError>;
+    createICollectionRow(marker: string, body: ICollectionFormObject, langCode?: string): Promise<ICollectionRow | IError>;
     /**
      * Edit a record in the collection.
      *
@@ -135,12 +154,22 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      *
      * @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 {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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     *
      * @description Edit a record in the collection.
      */
     updateICollectionRow(marker: string, id: number, body: {
@@ -154,11 +183,9 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      *
      * @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)
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     *
-     * @description
+     * @description Deletion of collection record object
      */
     deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<boolean | IError>;
 }

package/dist/integration-collections/integrationCollectionsApi.js

@@ -11,7 +11,6 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
  * @class IntegrationCollectionsApi
  * @extends 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 {
@@ -31,15 +30,19 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @handleName getICollections
      *
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters.
+     * @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 {number} [userQuery.entityType] - Entity type. Example: 1.
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: orders.
-     *
-     * @return {ICollection[]} Returns an array of ICollection objects or an error object if there was an issue.
+     * @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.
      * @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, 
@@ -57,16 +60,13 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      *
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
-     * @return {ICollection} Returns an ICollection object or an error object if there was an issue.
+     * @return {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 query = { langCode };
-        const result = await this._fetchGet(`/${id}?` + this._queryParamsToString(query));
+        const result = await this._fetchGet(`/${id}?` + this._queryParamsToString({ langCode }));
         return this._dataPostProcess(result, langCode);
     }
     /**
@@ -76,24 +76,28 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      *
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters. Example: .
-     *
+     * @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: 1.
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: "orders".
-     *
-     * @return {ICollectionResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @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.
      * @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.
      */
-    async getICollectionRowsById(id, langCode = this.state.lang, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    userQuery) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const query = { ...this._defaultQuery, ...userQuery, langCode };
-        const result = await this._fetchGet(`/${id}/rows?` + this._queryParamsToString(query));
+    async getICollectionRowsById(id, langCode = this.state.lang, userQuery) {
+        const result = await this._fetchGet(`/${id}/rows?` +
+            this._queryParamsToString({
+                ...this._defaultQuery,
+                ...userQuery,
+                langCode,
+            }));
         return this._dataPostProcess(result, langCode);
     }
     /**
@@ -102,11 +106,12 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @handleName validateICollectionMarker
      *
      * @param {string} marker - Collection marker. Example: "collection1".
-     *
-     * @return {any} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @return {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
+     * @description Check for the existence of a text identifier (marker).
      */
     async validateICollectionMarker(marker) {
         const result = await this._fetchGet(`/marker-validation/${marker}`);
@@ -119,10 +124,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      *
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
-     * @return {any} Returns CollectionRowEntity object.
+     * @return {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.
      */
     async getICollectionRowsByMarker(marker, langCode = this.state.lang) {
@@ -137,10 +140,8 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @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 {any} Returns CollectionRowEntity object.
+     * @return {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.
      */
     async getICollectionRowByMarkerAndId(marker, id, langCode = this.state.lang) {
@@ -153,12 +154,22 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @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 {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 {any} Returns object of type ICollectionRow.
+     * @return {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.
      */
     async createICollectionRow(marker, body, langCode = this.state.lang) {
@@ -172,12 +183,22 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      *
      * @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 {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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     *
      * @description Edit a record in the collection.
      */
     async updateICollectionRow(marker, id, body, langCode = this.state.lang) {
@@ -191,11 +212,9 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      *
      * @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)
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     *
-     * @description
+     * @description Deletion of collection record object
      */
     async deleteICollectionRowByMarkerAndId(marker, id) {
         const result = await this._fetchDelete(`/marker/${marker}/rows/${id}`);