oneentry 1.0.166 → 1.0.167

package/dist/payments/paymentsApi.js

@@ -157,5 +157,23 @@ class PaymentsApi extends asyncModules_1.default {
         const result = await this._fetchGet(`/accounts/${id}`);
         return this._normalizeData(result);
     }
+    /**
+     * Get the payment progress of an order: its stages and whether they are paid.
+     * @handleName getPaymentStagesByOrderId
+     * @param {number} id - ID of the order object. Example: 1.
+     * @returns {Promise<IPaymentProgress | IError>} Returns the payment progress of the order.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description An order can be paid in stages rather than in one payment — `partial` says
+     * which case it is, `completed` says whether nothing is left to pay, and every stage carries
+     * its own `status`. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getPaymentStagesByOrderId getPaymentStagesByOrderId} documentation.
+     */
+    async getPaymentStagesByOrderId(id) {
+        const result = await this._fetchGet(`/stages/order/${id}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('PaymentProgressSchema'));
+        return this._normalizeData(validated);
+    }
 }
 exports.default = PaymentsApi;

package/dist/payments/paymentsInterfaces.d.ts

@@ -66,6 +66,16 @@ interface IPaymentsApi {
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getAccountById(id: number): Promise<IAccountsEntity | IError>;
+    /**
+     * Get the payment progress of an order: its stages and whether they are paid.
+     * @handleName getPaymentStagesByOrderId
+     * @param {number} id - ID of the order object. Example: 1.
+     * @returns {IPaymentProgress} Returns the payment progress of the order.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets the payment stages of an order. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getPaymentStagesByOrderId(id: number): Promise<IPaymentProgress | IError>;
 }
 /**
  * @interface ISessionsEntity
@@ -186,4 +196,36 @@ interface IPaymentAccountTestSettings {
     signingSecretKey?: string;
     useWebHookValidation?: boolean;
 }
-export type { IAccountsEntity, IIntent, IPaymentAccountSettings, IPaymentAccountTestSettings, IPaymentsApi, ISessionEntity, ISessionsEntity, };
+/**
+ * The `IPaymentProgress` interface describes the payment progress of an order.
+ * @interface IPaymentProgress
+ * @property {boolean} completed - True when every stage of the order has been paid. Example: false.
+ * @property {boolean} partial - True when the order is paid in stages rather than in one payment. Example: true.
+ * @property {IPaymentStage[]} stages - The stages themselves, in the order the API returns them.
+ * @description This interface describes the payment progress of an order — whether it is fully paid, whether it is split into stages, and the stages themselves.
+ */
+interface IPaymentProgress {
+    completed: boolean;
+    partial: boolean;
+    stages: IPaymentStage[];
+}
+/**
+ * The `IPaymentStage` interface describes one payment stage of an order.
+ * @interface IPaymentStage
+ * @property {string} marker - Marker of the attribute that set the price of the stage. Example: "part_a".
+ * @property {number} sessionId - Identifier of the payment session bound to the stage. Example: 100.
+ * @property {number} productId - Identifier of the product the stage belongs to. Example: 200.
+ * @property {string} title - Title of the stage. Example: "Part A".
+ * @property {number} value - Price of the stage. Example: 150.
+ * @property {"planned" | "completed"} status - Stage status: "planned" — not paid yet, "completed" — paid. Example: "planned".
+ * @description This interface describes one payment stage of an order.
+ */
+interface IPaymentStage {
+    marker: string;
+    sessionId: number;
+    productId: number;
+    title: string;
+    value: number;
+    status: 'planned' | 'completed';
+}
+export type { IAccountsEntity, IIntent, IPaymentAccountSettings, IPaymentAccountTestSettings, IPaymentProgress, IPaymentsApi, IPaymentStage, ISessionEntity, ISessionsEntity, };

package/dist/payments/paymentsSchemas.d.ts

@@ -92,3 +92,35 @@ export declare const PaymentAccountsResponseSchema: z.ZodArray<z.ZodObject<{
     localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
     updatedDate: z.ZodString;
 }, z.core.$strip>>;
+/**
+ * Payment stage schema
+ */
+export declare const PaymentStageSchema: z.ZodObject<{
+    marker: z.ZodString;
+    sessionId: z.ZodNumber;
+    productId: z.ZodNumber;
+    title: z.ZodString;
+    value: z.ZodNumber;
+    status: z.ZodEnum<{
+        completed: "completed";
+        planned: "planned";
+    }>;
+}, z.core.$strip>;
+/**
+ * Payment progress schema — stages of one order plus their aggregate state
+ */
+export declare const PaymentProgressSchema: z.ZodObject<{
+    completed: z.ZodBoolean;
+    partial: z.ZodBoolean;
+    stages: z.ZodArray<z.ZodObject<{
+        marker: z.ZodString;
+        sessionId: z.ZodNumber;
+        productId: z.ZodNumber;
+        title: z.ZodString;
+        value: z.ZodNumber;
+        status: z.ZodEnum<{
+            completed: "completed";
+            planned: "planned";
+        }>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;

package/dist/payments/paymentsSchemas.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaymentAccountsResponseSchema = exports.PaymentAccountSchema = exports.SinglePaymentSessionSchema = exports.PaymentSessionsResponseSchema = exports.PaymentSessionSchema = void 0;
+exports.PaymentProgressSchema = exports.PaymentStageSchema = exports.PaymentAccountsResponseSchema = exports.PaymentAccountSchema = exports.SinglePaymentSessionSchema = exports.PaymentSessionsResponseSchema = exports.PaymentSessionSchema = void 0;
 const zod_1 = require("zod");
 /**
  * Payment session schema
@@ -54,3 +54,22 @@ exports.PaymentAccountSchema = zod_1.z.object({
  * Payment accounts response schema
  */
 exports.PaymentAccountsResponseSchema = zod_1.z.array(exports.PaymentAccountSchema);
+/**
+ * Payment stage schema
+ */
+exports.PaymentStageSchema = zod_1.z.object({
+    marker: zod_1.z.string(),
+    sessionId: zod_1.z.number(),
+    productId: zod_1.z.number(),
+    title: zod_1.z.string(),
+    value: zod_1.z.number(),
+    status: zod_1.z.enum(['planned', 'completed']),
+});
+/**
+ * Payment progress schema — stages of one order plus their aggregate state
+ */
+exports.PaymentProgressSchema = zod_1.z.object({
+    completed: zod_1.z.boolean(),
+    partial: zod_1.z.boolean(),
+    stages: zod_1.z.array(exports.PaymentStageSchema),
+});

package/dist/types.d.ts

@@ -31,5 +31,6 @@ export type * from './system/systemInterfaces';
 export type * from './templates/templatesInterfaces';
 export type * from './templates-preview/templatesPreviewInterfaces';
 export type * from './user-activity/userActivityInterfaces';
+export type * from './user-groups/userGroupsInterfaces';
 export type * from './users/usersInterfaces';
 export type * from './web-socket/wsInterfaces';

package/dist/user-groups/userGroupsApi.d.ts

@@ -0,0 +1,81 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IUserGroupEntity, IUserGroups } from './userGroupsInterfaces';
+/**
+ * Controllers for working with user groups
+ * @handle /api/content/user-groups
+ * @class UserGroupsApi
+ * @augments AsyncModules
+ * @implements {IUserGroups}
+ * @description User groups form a tree — a group may have a parent and children. The flat list
+ * comes from `getUserGroups`, the top level from `getRootUserGroups`, and the tree is walked
+ * downwards with `getChildUserGroupsByMarker`.
+ * @example
+ * const { UserGroups } = defineOneEntry('your-url', { token: 'your-app-token' });
+ * const roots = await UserGroups.getRootUserGroups();
+ */
+export default class UserGroupsApi extends AsyncModules implements IUserGroups {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the UserGroupsApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get all user group objects.
+     * @handleName getUserGroups
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserGroupEntity[] | IError>} Returns an array of user group objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Returns every group as a flat array, regardless of nesting.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getUserGroups getUserGroups} documentation.
+     */
+    getUserGroups(langCode?: string): Promise<IUserGroupEntity[] | IError>;
+    /**
+     * Get all top-level user group objects.
+     * @handleName getRootUserGroups
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserGroupEntity[] | IError>} Returns an array of user group objects with `parentId: null`.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Returns the groups of the top level — those without a parent.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getRootUserGroups getRootUserGroups} documentation.
+     */
+    getRootUserGroups(langCode?: string): Promise<IUserGroupEntity[] | IError>;
+    /**
+     * Get a single user group object by its identifier.
+     * @handleName getUserGroupById
+     * @param {number} id - Identifier of the user group. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserGroupEntity | IError>} Returns a single user group object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get a single user group object by its identifier.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getUserGroupById getUserGroupById} documentation.
+     */
+    getUserGroupById(id: number, langCode?: string): Promise<IUserGroupEntity | IError>;
+    /**
+     * Get a single user group object by its marker.
+     * @handleName getUserGroupByMarker
+     * @param {string} marker - Text identifier of the user group. Example: "guest".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserGroupEntity | IError>} Returns a single user group object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get a single user group object by its marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getUserGroupByMarker getUserGroupByMarker} documentation.
+     */
+    getUserGroupByMarker(marker: string, langCode?: string): Promise<IUserGroupEntity | IError>;
+    /**
+     * Get the child groups of a user group.
+     * @handleName getChildUserGroupsByMarker
+     * @param {string} marker - Text identifier of the parent user group. Example: "guest".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserGroupEntity[] | IError>} Returns an array of child user group objects, empty when the group has none.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get the child groups of a user group by the parent marker. The nesting is walked
+     * with this method rather than through `parentId`.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getChildUserGroupsByMarker getChildUserGroupsByMarker} documentation.
+     */
+    getChildUserGroupsByMarker(marker: string, langCode?: string): Promise<IUserGroupEntity[] | IError>;
+}

package/dist/user-groups/userGroupsApi.js

@@ -0,0 +1,145 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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 lazySchema_1 = __importDefault(require("../base/lazySchema"));
+const schema = (0, lazySchema_1.default)(() => Promise.resolve().then(() => __importStar(require('./userGroupsSchemas'))));
+/**
+ * Controllers for working with user groups
+ * @handle /api/content/user-groups
+ * @class UserGroupsApi
+ * @augments AsyncModules
+ * @implements {IUserGroups}
+ * @description User groups form a tree — a group may have a parent and children. The flat list
+ * comes from `getUserGroups`, the top level from `getRootUserGroups`, and the tree is walked
+ * downwards with `getChildUserGroupsByMarker`.
+ * @example
+ * const { UserGroups } = defineOneEntry('your-url', { token: 'your-app-token' });
+ * const roots = await UserGroups.getRootUserGroups();
+ */
+class UserGroupsApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the UserGroupsApi with a given state.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/user-groups';
+    }
+    /**
+     * Get all user group objects.
+     * @handleName getUserGroups
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserGroupEntity[] | IError>} Returns an array of user group objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Returns every group as a flat array, regardless of nesting.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getUserGroups getUserGroups} documentation.
+     */
+    async getUserGroups(langCode = this.state.lang) {
+        const result = await this._fetchGet(`/?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('UserGroupsResponseSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Get all top-level user group objects.
+     * @handleName getRootUserGroups
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserGroupEntity[] | IError>} Returns an array of user group objects with `parentId: null`.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Returns the groups of the top level — those without a parent.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getRootUserGroups getRootUserGroups} documentation.
+     */
+    async getRootUserGroups(langCode = this.state.lang) {
+        const result = await this._fetchGet(`/root?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('UserGroupsResponseSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Get a single user group object by its identifier.
+     * @handleName getUserGroupById
+     * @param {number} id - Identifier of the user group. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserGroupEntity | IError>} Returns a single user group object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get a single user group object by its identifier.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getUserGroupById getUserGroupById} documentation.
+     */
+    async getUserGroupById(id, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('UserGroupEntitySchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Get a single user group object by its marker.
+     * @handleName getUserGroupByMarker
+     * @param {string} marker - Text identifier of the user group. Example: "guest".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserGroupEntity | IError>} Returns a single user group object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get a single user group object by its marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getUserGroupByMarker getUserGroupByMarker} documentation.
+     */
+    async getUserGroupByMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('UserGroupEntitySchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Get the child groups of a user group.
+     * @handleName getChildUserGroupsByMarker
+     * @param {string} marker - Text identifier of the parent user group. Example: "guest".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserGroupEntity[] | IError>} Returns an array of child user group objects, empty when the group has none.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get the child groups of a user group by the parent marker. The nesting is walked
+     * with this method rather than through `parentId`.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getChildUserGroupsByMarker getChildUserGroupsByMarker} documentation.
+     */
+    async getChildUserGroupsByMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/marker/${marker}/children?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('UserGroupsResponseSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+}
+exports.default = UserGroupsApi;

package/dist/user-groups/userGroupsInterfaces.d.ts

@@ -0,0 +1,100 @@
+import type { IAttributeValues, IError, ILocalizeInfo } from '../base/utils';
+/**
+ * The `IUserGroups` interface defines methods for reading user groups.
+ * @interface IUserGroups
+ * @description User groups form a tree: a group may have a parent and children, and the tree is
+ * walked through the marker-based methods. Every method requires the project token.
+ */
+interface IUserGroups {
+    /**
+     * Get all user group objects.
+     * @handleName getUserGroups
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IUserGroupEntity[]} Returns an array of user group objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all user group objects, flat, regardless of nesting.
+     */
+    getUserGroups(langCode?: string): Promise<IUserGroupEntity[] | IError>;
+    /**
+     * Get all top-level user group objects.
+     * @handleName getRootUserGroups
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IUserGroupEntity[]} Returns an array of user group objects with `parentId: null`.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets the user groups of the top level — those without a parent.
+     */
+    getRootUserGroups(langCode?: string): Promise<IUserGroupEntity[] | IError>;
+    /**
+     * Get a single user group object by its identifier.
+     * @handleName getUserGroupById
+     * @param {number} id - Identifier of the user group. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IUserGroupEntity} Returns a single user group object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a single user group object by its identifier.
+     */
+    getUserGroupById(id: number, langCode?: string): Promise<IUserGroupEntity | IError>;
+    /**
+     * Get a single user group object by its marker.
+     * @handleName getUserGroupByMarker
+     * @param {string} marker - Text identifier of the user group. Example: "guest".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IUserGroupEntity} Returns a single user group object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a single user group object by its marker.
+     */
+    getUserGroupByMarker(marker: string, langCode?: string): Promise<IUserGroupEntity | IError>;
+    /**
+     * Get the child groups of a user group.
+     * @handleName getChildUserGroupsByMarker
+     * @param {string} marker - Text identifier of the parent user group. Example: "guest".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IUserGroupEntity[]} Returns an array of child user group objects, empty when the group has none.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets the child groups of a user group by the parent marker.
+     */
+    getChildUserGroupsByMarker(marker: string, langCode?: string): Promise<IUserGroupEntity[] | IError>;
+}
+/**
+ * The `IUserGroupEntity` interface defines the structure of a user group object.
+ * @interface IUserGroupEntity
+ * @property {number} id - Identifier of the user group. Example: 1.
+ * @property {number} depth - Nesting depth relative to the parent. Example: 0.
+ * @property {number | null} parentId - Identifier of the parent group, `null` for a top-level group. Example: null.
+ * @property {ILocalizeInfo} localizeInfos - Title of the group, taking localization into account.
+ * @property {boolean} isVisible - Visibility flag. Example: true.
+ * @property {string} childrenCount - Number of child groups. The API sends it as a **string**, not a number. Example: "0".
+ * @property {string} identifier - Text identifier (marker) of the group. Example: "guest".
+ * @property {boolean} isSync - Synchronization flag. Example: false.
+ * @property {IAttributeValues} attributeValues - Attribute values of the group.
+ * @property {number} [version] - Version of the object. Not present on every stand. Example: 0.
+ * @description Structure of a user group object.
+ * @example
+ * ```json
+ * {
+ *   "id": 1,
+ *   "depth": 0,
+ *   "parentId": null,
+ *   "localizeInfos": { "title": "Guest" },
+ *   "isVisible": true,
+ *   "childrenCount": "0",
+ *   "identifier": "guest",
+ *   "isSync": false,
+ *   "attributeValues": {},
+ *   "version": 0
+ * }
+ * ```
+ */
+interface IUserGroupEntity {
+    id: number;
+    depth: number;
+    parentId: number | null;
+    localizeInfos: ILocalizeInfo;
+    isVisible: boolean;
+    childrenCount: string;
+    identifier: string;
+    isSync: boolean;
+    attributeValues: IAttributeValues;
+    version?: number;
+}
+export type { IUserGroupEntity, IUserGroups };

package/dist/user-groups/userGroupsInterfaces.js

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

package/dist/user-groups/userGroupsSchemas.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Validation schemas for UserGroups module
+ * @description Zod schemas for validating user-group API responses
+ */
+import { z } from 'zod';
+/**
+ * User group entity schema.
+ *
+ * `childrenCount` is a **string** here because that is what the API sends
+ * (`"0"`), even though the platform DTO declares it a number. The schema
+ * describes the raw response, so it follows the response.
+ */
+export declare const UserGroupEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    depth: z.ZodNumber;
+    parentId: z.ZodNullable<z.ZodNumber>;
+    localizeInfos: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodObject<{
+        title: z.ZodString;
+        content: z.ZodOptional<z.ZodString>;
+        menuTitle: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>, z.ZodObject<{
+        title: z.ZodString;
+        content: z.ZodOptional<z.ZodString>;
+        menuTitle: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>]>;
+    isVisible: z.ZodBoolean;
+    childrenCount: z.ZodString;
+    identifier: z.ZodString;
+    isSync: z.ZodBoolean;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    version: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * User groups response schema (array of groups)
+ */
+export declare const UserGroupsResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    depth: z.ZodNumber;
+    parentId: z.ZodNullable<z.ZodNumber>;
+    localizeInfos: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodObject<{
+        title: z.ZodString;
+        content: z.ZodOptional<z.ZodString>;
+        menuTitle: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>, z.ZodObject<{
+        title: z.ZodString;
+        content: z.ZodOptional<z.ZodString>;
+        menuTitle: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>]>;
+    isVisible: z.ZodBoolean;
+    childrenCount: z.ZodString;
+    identifier: z.ZodString;
+    isSync: z.ZodBoolean;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    version: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>;

package/dist/user-groups/userGroupsSchemas.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserGroupsResponseSchema = exports.UserGroupEntitySchema = void 0;
+/**
+ * Validation schemas for UserGroups module
+ * @description Zod schemas for validating user-group API responses
+ */
+const zod_1 = require("zod");
+const validation_1 = require("../base/validation");
+/**
+ * User group entity schema.
+ *
+ * `childrenCount` is a **string** here because that is what the API sends
+ * (`"0"`), even though the platform DTO declares it a number. The schema
+ * describes the raw response, so it follows the response.
+ */
+exports.UserGroupEntitySchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    depth: zod_1.z.number(),
+    parentId: zod_1.z.number().nullable(),
+    localizeInfos: zod_1.z.union([
+        zod_1.z.record(zod_1.z.string(), validation_1.LocalizeInfoSchema),
+        validation_1.LocalizeInfoSchema,
+    ]),
+    isVisible: zod_1.z.boolean(),
+    childrenCount: zod_1.z.string(),
+    identifier: zod_1.z.string(),
+    isSync: zod_1.z.boolean(),
+    attributeValues: validation_1.AttributeValuesSchema,
+    version: zod_1.z.number().optional(),
+});
+/**
+ * User groups response schema (array of groups)
+ */
+exports.UserGroupsResponseSchema = zod_1.z.array(exports.UserGroupEntitySchema);

package/esm/base/utils.d.ts

@@ -5,7 +5,10 @@
  * @property {string} [deviceMetadata] - Device-metadata string sent as the `x-device-metadata` header on POST requests and token refresh, overriding the environment-derived fingerprint. The API binds refresh tokens to this header, so server-side flows that issue tokens on behalf of a browser (e.g. an OAuth code exchange) must pass the browser's string here — otherwise the token is bound to the server's fingerprint and cannot be refreshed from the browser. Obtain the string in the browser via `getDeviceMetadata()`. Can also be set later via `setDeviceMetadata`.
  * @property {string} [langCode] - specify the default language to avoid specifying it in every request.
  * @property {boolean} [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.
- * @property {boolean} [rawData] - Set to true to receive raw API responses without any transformation.
+ * @property {boolean} [rawData] - Set to true to keep an attribute's nested `additionalFields` as the
+ * array the API sends, instead of the marker-keyed map the SDK builds by default. It turns off only that
+ * transformation — locale unwrapping, sorting by `position`, single-file unwrapping and number casting
+ * still apply. `getAdditionalFields` returns the same marker map in either mode.
  * @property {object} [validation] - Validation settings for API responses.
  * @property {boolean} [auth] - An object with authorization settings.
  * @property {boolean} [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.
@@ -22,7 +25,7 @@
  * const config = {
  *     token: 'project.token.here',
  *     langCode: 'en_US',
- *     multipleRequests: true,
+ *     traficLimit: true,
  *     auth: {
  *         customAuth: false,
  *         refreshToken: 'user.refresh.token',

package/esm/base/validation.d.ts

@@ -99,16 +99,18 @@ export declare const AuthEntitySchema: z.ZodObject<{
  */
 export declare function createPaginatedSchema<T extends z.ZodTypeAny>(itemSchema: T): any;
 /**
- * Validation helper function
+ * Validation helper function.
+ *
+ * This is the strict half of the pair: it reports a failure instead of hiding it.
+ * Strictness is the choice of function, not an option — `validateResponseSafe` is the
+ * lenient one, and `_validateResponse` picks between them by `config.validation.strictMode`.
  * @param {z.ZodSchema<T>} schema - Zod schema to validate against
  * @param {unknown} data - Data to validate
- * @param {object} options - Validation options
- * @param {boolean} options.strict - Whether to use strict mode
- * @param {boolean} options.logErrors - Whether to log errors
+ * @param {object} [options] - Validation options
+ * @param {boolean} [options.logErrors] - Whether to log errors
  * @returns {object} Validated data or error
  */
 export declare function validateResponse<T>(schema: z.ZodSchema<T>, data: unknown, options?: {
-    strict?: boolean;
     logErrors?: boolean;
 }): {
     success: true;

package/esm/base/validation.js

@@ -169,12 +169,15 @@ export function createPaginatedSchema(itemSchema) {
     });
 }
 /**
- * Validation helper function
+ * Validation helper function.
+ *
+ * This is the strict half of the pair: it reports a failure instead of hiding it.
+ * Strictness is the choice of function, not an option — `validateResponseSafe` is the
+ * lenient one, and `_validateResponse` picks between them by `config.validation.strictMode`.
  * @param {z.ZodSchema<T>} schema - Zod schema to validate against
  * @param {unknown} data - Data to validate
- * @param {object} options - Validation options
- * @param {boolean} options.strict - Whether to use strict mode
- * @param {boolean} options.logErrors - Whether to log errors
+ * @param {object} [options] - Validation options
+ * @param {boolean} [options.logErrors] - Whether to log errors
  * @returns {object} Validated data or error
  */
 export function validateResponse(schema, data, options) {