oneentry 1.0.140 → 1.0.141

package/dist/forms-data/formsDataSchemas.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateFormsDataSchema = exports.PostFormResponseSchema = exports.FormsByMarkerDataResponseSchema = exports.FormByMarkerDataEntitySchema = exports.FormDataTypeSchema = void 0;
+/**
+ * Validation schemas for FormsData module
+ * @description Zod schemas for validating forms data-related API responses
+ */
+const zod_1 = require("zod");
+/**
+ * Form data type schema (flexible structure)
+ */
+exports.FormDataTypeSchema = zod_1.z.union([
+    zod_1.z.object({
+        marker: zod_1.z.string(),
+        type: zod_1.z.string(),
+        value: zod_1.z.any(),
+    }),
+    zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+]);
+/**
+ * Form by marker data entity schema
+ */
+exports.FormByMarkerDataEntitySchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    parentId: zod_1.z.number().nullish(),
+    formIdentifier: zod_1.z.string(),
+    depth: zod_1.z.number().optional(),
+    ip: zod_1.z.string().nullish(),
+    fingerprint: zod_1.z.string().nullish(),
+    status: zod_1.z.string().nullish(),
+    userIdentifier: zod_1.z.string().nullish(),
+    formData: zod_1.z.union([
+        zod_1.z.array(exports.FormDataTypeSchema),
+        zod_1.z.record(zod_1.z.string(), zod_1.z.array(exports.FormDataTypeSchema)),
+    ]),
+    attributeSetIdentifier: zod_1.z.string().nullish(),
+    time: zod_1.z.union([zod_1.z.date(), zod_1.z.string()]),
+    entityIdentifier: zod_1.z.string().optional(),
+    isUserAdmin: zod_1.z.boolean().optional(),
+    formModuleConfigId: zod_1.z.number().optional(),
+    moduleIdentifier: zod_1.z.string().optional(),
+    entityId: zod_1.z.number().optional(),
+});
+/**
+ * Forms by marker data response schema
+ */
+exports.FormsByMarkerDataResponseSchema = zod_1.z.object({
+    items: zod_1.z.array(exports.FormByMarkerDataEntitySchema),
+    total: zod_1.z.number(),
+});
+/**
+ * Post form response schema
+ */
+exports.PostFormResponseSchema = zod_1.z.object({
+    actionMessage: zod_1.z.union([zod_1.z.string(), zod_1.z.record(zod_1.z.string(), zod_1.z.any())]),
+    formData: zod_1.z.object({
+        id: zod_1.z.number(),
+        formIdentifier: zod_1.z.string(),
+        time: zod_1.z.string(),
+        entityIdentifier: zod_1.z.string(),
+        fingerprint: zod_1.z.string(),
+        isUserAdmin: zod_1.z.boolean(),
+        formModuleId: zod_1.z.number(),
+        userIdentifier: zod_1.z.any(),
+        parentId: zod_1.z.any(),
+        formData: zod_1.z.union([
+            zod_1.z.array(exports.FormDataTypeSchema),
+            zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+        ]),
+    }),
+});
+/**
+ * Update forms data response schema
+ */
+exports.UpdateFormsDataSchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    formIdentifier: zod_1.z.string(),
+    time: zod_1.z.string(),
+    formData: zod_1.z.array(exports.FormDataTypeSchema),
+    userIdentifier: zod_1.z.string(),
+    entityIdentifier: zod_1.z.string(),
+    parentId: zod_1.z.number().nullable(),
+    fingerprint: zod_1.z.string().nullable(),
+    isUserAdmin: zod_1.z.boolean(),
+    formModuleId: zod_1.z.number(),
+});

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

@@ -0,0 +1,28 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IGeneralTypes, IGeneralTypesEntity } from './generalTypesInterfaces';
+/**
+ * Controllers for working with types
+ * @handle /api/content/general-types
+ * @class GeneralTypesApi
+ * @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 for the GeneralTypesApi class.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get all types.
+     * @handleName getAllTypes
+     * @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.
+     */
+    getAllTypes(): Promise<IGeneralTypesEntity[] | IError>;
+}

package/dist/general-types/generalTypesApi.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+const generalTypesSchemas_1 = require("./generalTypesSchemas");
+/**
+ * Controllers for working with types
+ * @handle /api/content/general-types
+ * @class GeneralTypesApi
+ * @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 for the GeneralTypesApi class.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/general-types';
+    }
+    /**
+     * Get all types.
+     * @handleName getAllTypes
+     * @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.
+     */
+    async getAllTypes() {
+        const result = await this._fetchGet('');
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, generalTypesSchemas_1.GeneralTypesResponseSchema);
+        return validated;
+    }
+}
+exports.default = GeneralTypesApi;

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

@@ -0,0 +1,30 @@
+import type { IError } from '../base/utils';
+import type { BlockType } from '../blocks/blocksInterfaces';
+/**
+ * Interface for retrieving all general types in the system.
+ * @interface IGeneralTypes
+ * @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.
+     * @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.
+ */
+interface IGeneralTypesEntity {
+    id: number;
+    type: BlockType;
+}
+export type { IGeneralTypes, IGeneralTypesEntity };

package/dist/general-types/generalTypesInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,50 @@
+/**
+ * Validation schemas for GeneralTypes module
+ * @description Zod schemas for validating general types-related API responses
+ */
+import { z } from 'zod';
+/**
+ * General type entity schema
+ * Includes all fields returned by the API
+ */
+export declare const GeneralTypeEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    type: z.ZodEnum<{
+        none: "none";
+        product: "product";
+        order: "order";
+        form: "form";
+        error_page: "error_page";
+        catalog_page: "catalog_page";
+        product_preview: "product_preview";
+        similar_products_block: "similar_products_block";
+        product_block: "product_block";
+        common_page: "common_page";
+        common_block: "common_block";
+        service: "service";
+        external_page: "external_page";
+        discount: "discount";
+    }>;
+}, z.core.$strip>;
+/**
+ * General types response schema (array of general types)
+ */
+export declare const GeneralTypesResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    type: z.ZodEnum<{
+        none: "none";
+        product: "product";
+        order: "order";
+        form: "form";
+        error_page: "error_page";
+        catalog_page: "catalog_page";
+        product_preview: "product_preview";
+        similar_products_block: "similar_products_block";
+        product_block: "product_block";
+        common_page: "common_page";
+        common_block: "common_block";
+        service: "service";
+        external_page: "external_page";
+        discount: "discount";
+    }>;
+}, z.core.$strip>>;

package/dist/general-types/generalTypesSchemas.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneralTypesResponseSchema = exports.GeneralTypeEntitySchema = void 0;
+/**
+ * Validation schemas for GeneralTypes module
+ * @description Zod schemas for validating general types-related API responses
+ */
+const zod_1 = require("zod");
+/**
+ * General type entity schema
+ * Includes all fields returned by the API
+ */
+exports.GeneralTypeEntitySchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    type: zod_1.z.enum([
+        'product',
+        'error_page',
+        'catalog_page',
+        'product_preview',
+        'similar_products_block',
+        'product_block',
+        'form',
+        'common_page',
+        'common_block',
+        'order',
+        'service',
+        'external_page',
+        'discount',
+        'none',
+    ]),
+});
+/**
+ * General types response schema (array of general types)
+ */
+exports.GeneralTypesResponseSchema = zod_1.z.array(exports.GeneralTypeEntitySchema);

package/dist/index.d.ts

@@ -0,0 +1,100 @@
+/**
+ * OneEntry SDK
+ */
+import AdminsApi from './admins/adminsApi';
+import AttributesSetsApi from './attribute-sets/attributeSetsApi';
+import AuthProviderApi from './auth-provider/authProviderApi';
+import type { IConfig } from './base/utils';
+import BlocksApi from './blocks/blocksApi';
+import DiscountsApi from './discounts/discountsApi';
+import EventsApi from './events/eventsApi';
+import FileUploadingApi from './file-uploading/fileUploadingApi';
+import FormsApi from './forms/formsApi';
+import FormsDataApi from './forms-data/formsDataApi';
+import GeneralTypesApi from './general-types/generalTypesApi';
+import IntegrationCollectionsApi from './integration-collections/integrationCollectionsApi';
+import LocalesApi from './locales/localesApi';
+import MenusApi from './menus/menusApi';
+import OrdersApi from './orders/ordersApi';
+import PagesApi from './pages/pagesApi';
+import PaymentsApi from './payments/paymentsApi';
+import ProductStatusesApi from './product-statuses/productStatusesApi';
+import ProductsApi from './products/productsApi';
+import SitemapApi from './sitemap/sitemapApi';
+import SystemApi from './system/systemApi';
+import TemplatesApi from './templates/templatesApi';
+import TemplatePreviewsApi from './templates-preview/templatesPreviewApi';
+import UsersApi from './users/usersApi';
+import WsApi from './web-socket/wsApi';
+/**
+ * IDefineApi interface
+ * @interface IDefineApi
+ * @property {AdminsApi} Admins - Admins API module.
+ * @property {AttributesSetsApi} AttributesSets - Attribute sets API module.
+ * @property {AuthProviderApi} AuthProvider - Auth provider API module.
+ * @property {BlocksApi} Blocks - Blocks API module.
+ * @property {EventsApi} Events - Events API module.
+ * @property {DiscountsApi} Discounts - Discounts API module.
+ * @property {FileUploadingApi} FileUploading - File uploading API module.
+ * @property {FormsApi} Forms - Forms API module.
+ * @property {FormsDataApi} FormData - Form data API module.
+ * @property {GeneralTypesApi} GeneralTypes - General types API module.
+ * @property {IntegrationCollectionsApi} IntegrationCollections - Integration collections API module.
+ * @property {LocalesApi} Locales - Locales API module.
+ * @property {MenusApi} Menus - Menus API module.
+ * @property {OrdersApi} Orders - Orders API module.
+ * @property {PageApi} Pages - Pages API module.
+ * @property {PaymentsApi} Payments - Payments API module.
+ * @property {ProductsApi} Products - Products API module.
+ * @property {ProductStatusesApi} ProductStatuses - Product statuses API module.
+ * @property {SitemapApi} Sitemap - Sitemap API module.
+ * @property {SystemApi} System - System API module.
+ * @property {TemplatesApi} Templates - Templates API module.
+ * @property {TemplatePreviewsApi} TemplatePreviews - Template previews API module.
+ * @property {UsersApi} Users - Users API module.
+ * @property {WsApi} WS - WebSocket API module.
+ */
+interface IDefineApi {
+    Admins: AdminsApi;
+    AttributesSets: AttributesSetsApi;
+    AuthProvider: AuthProviderApi;
+    Blocks: BlocksApi;
+    Events: EventsApi;
+    Discounts: DiscountsApi;
+    FileUploading: FileUploadingApi;
+    Forms: FormsApi;
+    FormData: FormsDataApi;
+    GeneralTypes: GeneralTypesApi;
+    IntegrationCollections: IntegrationCollectionsApi;
+    Locales: LocalesApi;
+    Menus: MenusApi;
+    Orders: OrdersApi;
+    Pages: PagesApi;
+    Payments: PaymentsApi;
+    Products: ProductsApi;
+    ProductStatuses: ProductStatusesApi;
+    Sitemap: SitemapApi;
+    System: SystemApi;
+    Templates: TemplatesApi;
+    TemplatePreviews: TemplatePreviewsApi;
+    Users: UsersApi;
+    WS: WsApi;
+}
+/**
+ * Define API.
+ * @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.providerMarker] - The marker of the authorization provider.
+ * @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

@@ -0,0 +1,103 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineOneEntry = defineOneEntry;
+/**
+ * OneEntry SDK
+ */
+const adminsApi_1 = __importDefault(require("./admins/adminsApi"));
+const attributeSetsApi_1 = __importDefault(require("./attribute-sets/attributeSetsApi"));
+const authProviderApi_1 = __importDefault(require("./auth-provider/authProviderApi"));
+const stateModule_1 = __importDefault(require("./base/stateModule"));
+const blocksApi_1 = __importDefault(require("./blocks/blocksApi"));
+const discountsApi_1 = __importDefault(require("./discounts/discountsApi"));
+const eventsApi_1 = __importDefault(require("./events/eventsApi"));
+const fileUploadingApi_1 = __importDefault(require("./file-uploading/fileUploadingApi"));
+const formsApi_1 = __importDefault(require("./forms/formsApi"));
+const formsDataApi_1 = __importDefault(require("./forms-data/formsDataApi"));
+const generalTypesApi_1 = __importDefault(require("./general-types/generalTypesApi"));
+const integrationCollectionsApi_1 = __importDefault(require("./integration-collections/integrationCollectionsApi"));
+const localesApi_1 = __importDefault(require("./locales/localesApi"));
+const menusApi_1 = __importDefault(require("./menus/menusApi"));
+const ordersApi_1 = __importDefault(require("./orders/ordersApi"));
+const pagesApi_1 = __importDefault(require("./pages/pagesApi"));
+const paymentsApi_1 = __importDefault(require("./payments/paymentsApi"));
+const productStatusesApi_1 = __importDefault(require("./product-statuses/productStatusesApi"));
+const productsApi_1 = __importDefault(require("./products/productsApi"));
+const sitemapApi_1 = __importDefault(require("./sitemap/sitemapApi"));
+const systemApi_1 = __importDefault(require("./system/systemApi"));
+const templatesApi_1 = __importDefault(require("./templates/templatesApi"));
+const templatesPreviewApi_1 = __importDefault(require("./templates-preview/templatesPreviewApi"));
+const usersApi_1 = __importDefault(require("./users/usersApi"));
+const wsApi_1 = __importDefault(require("./web-socket/wsApi"));
+/**
+ * Define API.
+ * @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.providerMarker] - The marker of the authorization provider.
+ * @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);
+    const Admins = new adminsApi_1.default(stateModule);
+    const AttributesSets = new attributeSetsApi_1.default(stateModule);
+    const AuthProvider = new authProviderApi_1.default(stateModule);
+    const Blocks = new blocksApi_1.default(stateModule);
+    const Discounts = new discountsApi_1.default(stateModule);
+    const Events = new eventsApi_1.default(stateModule);
+    const FileUploading = new fileUploadingApi_1.default(stateModule);
+    const Forms = new formsApi_1.default(stateModule);
+    const FormData = new formsDataApi_1.default(stateModule);
+    const GeneralTypes = new generalTypesApi_1.default(stateModule);
+    const IntegrationCollections = new integrationCollectionsApi_1.default(stateModule);
+    const Locales = new localesApi_1.default(stateModule);
+    const Menus = new menusApi_1.default(stateModule);
+    const Orders = new ordersApi_1.default(stateModule);
+    const Pages = new pagesApi_1.default(stateModule);
+    const Payments = new paymentsApi_1.default(stateModule);
+    const Products = new productsApi_1.default(stateModule);
+    const ProductStatuses = new productStatusesApi_1.default(stateModule);
+    const Sitemap = new sitemapApi_1.default(stateModule);
+    const System = new systemApi_1.default(stateModule);
+    const Templates = new templatesApi_1.default(stateModule);
+    const TemplatePreviews = new templatesPreviewApi_1.default(stateModule);
+    const Users = new usersApi_1.default(stateModule);
+    const WS = new wsApi_1.default(stateModule);
+    return {
+        Admins,
+        AttributesSets,
+        AuthProvider,
+        Blocks,
+        Discounts,
+        Events,
+        FileUploading,
+        Forms,
+        FormData,
+        GeneralTypes,
+        IntegrationCollections,
+        Locales,
+        Menus,
+        Orders,
+        Pages,
+        Payments,
+        Products,
+        ProductStatuses,
+        Sitemap,
+        System,
+        Templates,
+        TemplatePreviews,
+        Users,
+        WS,
+    };
+}

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

@@ -0,0 +1,173 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+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
+ * @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.
+     * @returns {Promise<ICollectionEntity[] | IError>} Returns an array of ICollection objects or an error object if there was an issue.
+     */
+    getICollections(langCode?: string, userQuery?: {
+        limit: number;
+        offset: number;
+        entityType: string;
+        entityId: number;
+    }): 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".
+     * @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
+     */
+    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.
+     * @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.
+     */
+    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".
+     * @returns {Promise<ICollectionIsValid | IError>} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @example
+        {
+          "valid": true
+        }
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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".
+     * @returns {Promise<ICollectionRowsResponce | IError>} Returns CollectionRowEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    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".
+     * @returns {Promise<ICollectionRow | IError>} Returns CollectionRowEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    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": [
+            {
+            "marker": "collection_marker",
+            "type": "string",
+            "value": "Collection marker"
+            }
+          ]
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @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.
+     */
+    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": [
+            {
+              "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 {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.
+     */
+    updateICollectionRow(marker: string, id: number, body: {
+        formIdentifier: string;
+        formData: any;
+    }, 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.
+     * @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
+     */
+    deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<boolean | IError>;
+}