oneentry 1.0.166 → 1.0.167

package/esm/file-uploading/fileUploadingApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules.js';
 import type StateModule from '../base/stateModule.js';
 import type { IError } from '../base/utils.js';
-import type { IFileUploading, IUploadingQuery, IUploadingReturn } from './fileUploadingInterfaces.js';
+import type { IFileSearchResponse, IFileUploading, IUploadingQuery, IUploadingReturn } from './fileUploadingInterfaces.js';
 /**
  * Controllers for working with file uploading
  * @handle /api/content/files
@@ -67,6 +67,32 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/delete delete} documentation.
      */
     delete(filename: string, fileQuery?: IUploadingQuery): Promise<boolean | IError>;
+    /**
+     * Public search across the content of files attached to records.
+     * @handleName searchFileContent
+     * @param {string} query - Search query, at least 3 characters — shorter is rejected with 400. Example: "transportation".
+     * @param {string} [langCode] - Language of the query. Example: "en_US".
+     * @param {string[]} [extensions] - Filter by file extension, sent comma-separated. Example: ["pdf", "docx"].
+     * @param {string[]} [ownerTables] - Filter by the section the attached record belongs to, sent comma-separated. Example: ["products", "pages"].
+     * @param {string[]} [localeCodes] - Filter by the locale of the link, not of the file content. Example: ["en_US"].
+     * @param {boolean} [onlyTruncated] - Return only files whose extracted text was cut at the size ceiling.
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 10, maximum 50 — a larger value is rejected with 400 "limit must not be greater than 50".
+     * @returns {Promise<IFileSearchResponse | IError>} Returns the found files with their matching fragments.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description The unit of the result is a **file, not a fragment**: one `snippet` per file,
+     * even when the document matches on many pages. Matches inside the snippet are wrapped in the
+     * control characters `U+0002` and `U+0003` rather than HTML, so replace them before rendering.
+     * The result is narrowed by access: only files of visible records of the sections enabled in the
+     * project settings, personal sections only down to the caller's own records, and the admins
+     * section is never returned. A separate 403 means the feature is not part of the project tariff.
+     * @example
+     * ```ts
+     * const found = await api.FileUploading.searchFileContent('transportation', 'en_US', ['pdf']);
+     * ```
+     * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/searchFileContent searchFileContent} documentation.
+     */
+    searchFileContent(query: string, langCode?: string, extensions?: string[], ownerTables?: string[], localeCodes?: string[], onlyTruncated?: boolean, offset?: number, limit?: number): Promise<IFileSearchResponse | IError>;
     /**
      * Create a File object from a URL.
      * @param {string} url - The URL to fetch the file from.

package/esm/file-uploading/fileUploadingApi.js

@@ -87,6 +87,48 @@ export default class FileUploadingApi extends AsyncModules {
         const result = await this._fetchDelete(`?filename=${filename}&` + this._queryParamsToString(query));
         return result;
     }
+    /**
+     * Public search across the content of files attached to records.
+     * @handleName searchFileContent
+     * @param {string} query - Search query, at least 3 characters — shorter is rejected with 400. Example: "transportation".
+     * @param {string} [langCode] - Language of the query. Example: "en_US".
+     * @param {string[]} [extensions] - Filter by file extension, sent comma-separated. Example: ["pdf", "docx"].
+     * @param {string[]} [ownerTables] - Filter by the section the attached record belongs to, sent comma-separated. Example: ["products", "pages"].
+     * @param {string[]} [localeCodes] - Filter by the locale of the link, not of the file content. Example: ["en_US"].
+     * @param {boolean} [onlyTruncated] - Return only files whose extracted text was cut at the size ceiling.
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 10, maximum 50 — a larger value is rejected with 400 "limit must not be greater than 50".
+     * @returns {Promise<IFileSearchResponse | IError>} Returns the found files with their matching fragments.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description The unit of the result is a **file, not a fragment**: one `snippet` per file,
+     * even when the document matches on many pages. Matches inside the snippet are wrapped in the
+     * control characters `U+0002` and `U+0003` rather than HTML, so replace them before rendering.
+     * The result is narrowed by access: only files of visible records of the sections enabled in the
+     * project settings, personal sections only down to the caller's own records, and the admins
+     * section is never returned. A separate 403 means the feature is not part of the project tariff.
+     * @example
+     * ```ts
+     * const found = await api.FileUploading.searchFileContent('transportation', 'en_US', ['pdf']);
+     * ```
+     * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/searchFileContent searchFileContent} documentation.
+     */
+    async searchFileContent(query, langCode = this.state.lang, extensions, ownerTables, localeCodes, onlyTruncated, offset, limit) {
+        // Array filters are sent comma-separated — an array stringifies to exactly that.
+        const params = {
+            q: query,
+            langCode,
+            extensions,
+            ownerTables,
+            localeCodes,
+            onlyTruncated,
+            offset,
+            limit,
+        };
+        const result = await this._fetchGet(`/search?` + this._queryParamsToString(params));
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('FileSearchResponseSchema'));
+        return this._normalizeData(validated);
+    }
     /**
      * Create a File object from a URL.
      * @param {string} url - The URL to fetch the file from.

package/esm/file-uploading/fileUploadingInterfaces.d.ts

@@ -71,6 +71,22 @@ interface IFileUploading {
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
     getFile(id: number, type: string, entity: string, filename: string, template?: string): Promise<Response | IError>;
+    /**
+     * Public search across the content of files attached to records.
+     * @handleName searchFileContent
+     * @param {string} query - Search query, at least 3 characters. Example: "transportation".
+     * @param {string} [langCode] - Language of the query. Example: "en_US".
+     * @param {string[]} [extensions] - Filter by file extension, sent comma-separated. Example: ["pdf", "docx"].
+     * @param {string[]} [ownerTables] - Filter by the section the attached record belongs to. Example: ["products", "pages"].
+     * @param {string[]} [localeCodes] - Filter by the locale of the link, not of the file content. Example: ["en_US"].
+     * @param {boolean} [onlyTruncated] - Return only files whose extracted text was cut at the size ceiling.
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination, 1 to 50. Default: 10.
+     * @returns {IFileSearchResponse} Returns the found files with their matching fragments.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches the content of files attached to records.
+     */
+    searchFileContent(query: string, langCode?: string, extensions?: string[], ownerTables?: string[], localeCodes?: string[], onlyTruncated?: boolean, offset?: number, limit?: number): Promise<IFileSearchResponse | IError>;
 }
 /**
  * Represents a file entity that may contain a file object or a path as a string.
@@ -113,4 +129,89 @@ interface IUploadingReturn {
     size: number;
     contentType: string;
 }
-export type { IFileEntity, IFileUploading, IUploadingQuery, IUploadingReturn };
+/**
+ * The `IFileSearchOwner` interface describes one record a found file is attached to.
+ * @interface IFileSearchOwner
+ * @property {string} tableName - Section the record belongs to. Example: "products".
+ * @property {number} dataId - Identifier of the record. Example: 644.
+ * @property {string} title - Title of the record. Example: "COG — March 17, 2016".
+ * @property {string} langCode - Locale of the link, not of the file content. Example: "en_US".
+ * @description One record a found file is attached to. The same file can be attached to several records, and a record contributes one entry per locale.
+ */
+interface IFileSearchOwner {
+    tableName: string;
+    dataId: number;
+    title: string;
+    langCode: string;
+}
+/**
+ * The `IFileSearchSnippet` interface describes the matching fragment of a file.
+ * @interface IFileSearchSnippet
+ * @property {string} text - The fragment itself. Every match inside it is wrapped in the control characters U+0002 and U+0003 — not HTML, so replace them before rendering. Example: "… Active \u0002Transportation\u0003 2…".
+ * @property {number | null} pageFrom - Page the fragment starts on, for paged formats. Example: 86.
+ * @description The matching fragment of a file. One fragment per file, even when the document matches on many pages.
+ */
+interface IFileSearchSnippet {
+    text: string;
+    pageFrom: number | null;
+}
+/**
+ * The `IFileSearchItem` interface describes one found file.
+ * @interface IFileSearchItem
+ * @property {number} id - Identifier of the indexed file. Example: 1077.
+ * @property {string} storageKey - Key of the object in the storage; the file link is built from it. Example: "files/project/file/644/product/db1918c4.pdf".
+ * @property {string} extension - File extension. Example: "pdf".
+ * @property {string | null} title - Title from the document metadata, `null` when the document carries none. Example: "Microsoft Word - COG Agenda.docx".
+ * @property {string | null} langCode - Language of the file content, detected on indexing. Example: "en".
+ * @property {number | null} pageCount - Number of pages, for paged formats. Example: 244.
+ * @property {number} rank - Relevance of the match; the API sorts by it descending. Example: 0.0971.
+ * @property {IFileSearchSnippet | null} snippet - The matching fragment.
+ * @property {IFileSearchOwner[]} owners - Records the file is attached to, limited to those the caller may see.
+ * @property {number} ownersTotal - How many records visible to the caller reference the file. Example: 2.
+ * @description One found file. The unit of the result is a file, not a fragment.
+ */
+interface IFileSearchItem {
+    id: number;
+    storageKey: string;
+    extension: string;
+    title: string | null;
+    langCode: string | null;
+    pageCount: number | null;
+    rank: number;
+    snippet: IFileSearchSnippet | null;
+    owners: IFileSearchOwner[];
+    ownersTotal: number;
+}
+/**
+ * The `IFileSearchQueryLanguage` interface describes how the query language was resolved.
+ * @interface IFileSearchQueryLanguage
+ * @property {string[]} resolved - Languages the query was actually run in. Example: ["english"].
+ * @property {string} source - How they were chosen: "explicit" when taken from `langCode`, otherwise detected. Example: "explicit".
+ * @property {string[]} candidates - Languages considered. Example: ["english"].
+ * @description How the query language was resolved for the search.
+ */
+interface IFileSearchQueryLanguage {
+    resolved: string[];
+    source: string;
+    candidates: string[];
+}
+/**
+ * The `IFileSearchResponse` interface describes the result of a file content search.
+ * @interface IFileSearchResponse
+ * @property {number} total - Total number of matching files. Example: 166.
+ * @property {number} offset - Offset the page starts at. Example: 0.
+ * @property {number} limit - Page size. Example: 10.
+ * @property {IFileSearchQueryLanguage} queryLanguage - How the query language was resolved.
+ * @property {string[]} warnings - Warnings about the search, empty when there are none.
+ * @property {IFileSearchItem[]} items - The found files.
+ * @description The result of a file content search.
+ */
+interface IFileSearchResponse {
+    total: number;
+    offset: number;
+    limit: number;
+    queryLanguage: IFileSearchQueryLanguage;
+    warnings: string[];
+    items: IFileSearchItem[];
+}
+export type { IFileEntity, IFileSearchItem, IFileSearchOwner, IFileSearchQueryLanguage, IFileSearchResponse, IFileSearchSnippet, IFileUploading, IUploadingQuery, IUploadingReturn, };

package/esm/file-uploading/fileUploadingSchemas.d.ts

@@ -22,3 +22,76 @@ export declare const UploadResponseSchema: z.ZodArray<z.ZodObject<{
     size: z.ZodNumber;
     contentType: z.ZodString;
 }, z.core.$strip>>;
+/**
+ * One record a found file is attached to
+ */
+export declare const FileSearchOwnerSchema: z.ZodObject<{
+    tableName: z.ZodString;
+    dataId: z.ZodNumber;
+    title: z.ZodString;
+    langCode: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Matching fragment of a found file
+ */
+export declare const FileSearchSnippetSchema: z.ZodObject<{
+    text: z.ZodString;
+    pageFrom: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * One found file
+ */
+export declare const FileSearchItemSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    storageKey: z.ZodString;
+    extension: z.ZodString;
+    title: z.ZodNullable<z.ZodString>;
+    langCode: z.ZodNullable<z.ZodString>;
+    pageCount: z.ZodNullable<z.ZodNumber>;
+    rank: z.ZodNumber;
+    snippet: z.ZodNullable<z.ZodObject<{
+        text: z.ZodString;
+        pageFrom: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+    owners: z.ZodArray<z.ZodObject<{
+        tableName: z.ZodString;
+        dataId: z.ZodNumber;
+        title: z.ZodString;
+        langCode: z.ZodString;
+    }, z.core.$strip>>;
+    ownersTotal: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * File content search response
+ */
+export declare const FileSearchResponseSchema: z.ZodObject<{
+    total: z.ZodNumber;
+    offset: z.ZodNumber;
+    limit: z.ZodNumber;
+    queryLanguage: z.ZodObject<{
+        resolved: z.ZodArray<z.ZodString>;
+        source: z.ZodString;
+        candidates: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>;
+    warnings: z.ZodArray<z.ZodString>;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        storageKey: z.ZodString;
+        extension: z.ZodString;
+        title: z.ZodNullable<z.ZodString>;
+        langCode: z.ZodNullable<z.ZodString>;
+        pageCount: z.ZodNullable<z.ZodNumber>;
+        rank: z.ZodNumber;
+        snippet: z.ZodNullable<z.ZodObject<{
+            text: z.ZodString;
+            pageFrom: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+        owners: z.ZodArray<z.ZodObject<{
+            tableName: z.ZodString;
+            dataId: z.ZodNumber;
+            title: z.ZodString;
+            langCode: z.ZodString;
+        }, z.core.$strip>>;
+        ownersTotal: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;

package/esm/file-uploading/fileUploadingSchemas.js

@@ -17,3 +17,49 @@ export const UploadingReturnSchema = z.object({
  * Upload response schema (array of upload results)
  */
 export const UploadResponseSchema = z.array(UploadingReturnSchema);
+/**
+ * One record a found file is attached to
+ */
+export const FileSearchOwnerSchema = z.object({
+    tableName: z.string(),
+    dataId: z.number(),
+    title: z.string(),
+    langCode: z.string(),
+});
+/**
+ * Matching fragment of a found file
+ */
+export const FileSearchSnippetSchema = z.object({
+    text: z.string(),
+    pageFrom: z.number().nullable(),
+});
+/**
+ * One found file
+ */
+export const FileSearchItemSchema = z.object({
+    id: z.number(),
+    storageKey: z.string(),
+    extension: z.string(),
+    title: z.string().nullable(),
+    langCode: z.string().nullable(),
+    pageCount: z.number().nullable(),
+    rank: z.number(),
+    snippet: FileSearchSnippetSchema.nullable(),
+    owners: z.array(FileSearchOwnerSchema),
+    ownersTotal: z.number(),
+});
+/**
+ * File content search response
+ */
+export const FileSearchResponseSchema = z.object({
+    total: z.number(),
+    offset: z.number(),
+    limit: z.number(),
+    queryLanguage: z.object({
+        resolved: z.array(z.string()),
+        source: z.string(),
+        candidates: z.array(z.string()),
+    }),
+    warnings: z.array(z.string()),
+    items: z.array(FileSearchItemSchema),
+});

package/esm/index.d.ts

@@ -28,6 +28,7 @@ import SystemApi from './system/systemApi.js';
 import TemplatesApi from './templates/templatesApi.js';
 import TemplatePreviewsApi from './templates-preview/templatesPreviewApi.js';
 import UserActivityApi from './user-activity/userActivityApi.js';
+import UserGroupsApi from './user-groups/userGroupsApi.js';
 import UsersApi from './users/usersApi.js';
 import WsApi from './web-socket/wsApi.js';
 export { getAdditionalFields, getAttributeFile, getAttributeFiles, isFileAttribute, isListAttribute, isNumberAttribute, isStringAttribute, } from './base/attributes.js';
@@ -62,6 +63,7 @@ export type * from './types.js';
  * @property {TemplatesApi} Templates - Templates API module.
  * @property {TemplatePreviewsApi} TemplatePreviews - Template previews API module.
  * @property {UserActivityApi} UserActivity - User activity API module.
+ * @property {UserGroupsApi} UserGroups - User groups API module.
  * @property {UsersApi} Users - Users API module.
  * @property {WsApi} WS - WebSocket API module.
  */
@@ -118,6 +120,8 @@ interface IDefineApi {
     TemplatePreviews: TemplatePreviewsApi;
     /** User/guest activity tracking: trackUserActivity */
     UserActivity: UserActivityApi;
+    /** User groups tree: getUserGroups, getRootUserGroups, getUserGroupByMarker, getChildUserGroupsByMarker */
+    UserGroups: UserGroupsApi;
     /** Current authenticated user: getUser, updateUser */
     Users: UsersApi;
     /** WebSocket real-time updates */

package/esm/index.js

@@ -28,6 +28,7 @@ import SystemApi from './system/systemApi.js';
 import TemplatesApi from './templates/templatesApi.js';
 import TemplatePreviewsApi from './templates-preview/templatesPreviewApi.js';
 import UserActivityApi from './user-activity/userActivityApi.js';
+import UserGroupsApi from './user-groups/userGroupsApi.js';
 import UsersApi from './users/usersApi.js';
 import WsApi from './web-socket/wsApi.js';
 export { getAdditionalFields, getAttributeFile, getAttributeFiles, isFileAttribute, isListAttribute, isNumberAttribute, isStringAttribute, } from './base/attributes.js';
@@ -90,6 +91,7 @@ export function defineOneEntry(url, config) {
     const Templates = new TemplatesApi(stateModule);
     const TemplatePreviews = new TemplatePreviewsApi(stateModule);
     const UserActivity = new UserActivityApi(stateModule);
+    const UserGroups = new UserGroupsApi(stateModule);
     const Users = new UsersApi(stateModule);
     const WS = new WsApi(stateModule);
     return {
@@ -119,6 +121,7 @@ export function defineOneEntry(url, config) {
         Templates,
         TemplatePreviews,
         UserActivity,
+        UserGroups,
         Users,
         WS,
     };

package/esm/orders/ordersApi.d.ts

@@ -70,6 +70,20 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrderByMarkerAndId getOrderByMarkerAndId} documentation.
      */
     getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
+    /**
+     * Getting a single order created by the user, by its own id.
+     * @handleName getOrderById
+     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization. Unlike `getOrderByMarkerAndId`,
+     * it does not need the storage marker — use it when only the order id is at hand, for
+     * example on the return URL of a payment provider or in a link from a notification.
+     * @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/orders/getOrderById getOrderById} documentation.
+     */
+    getOrderById(id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
     /**
      * Preview order calculation with discounts and coupons (without saving).
      * @handleName previewOrder

package/esm/orders/ordersApi.js

@@ -86,6 +86,25 @@ export default class OrdersApi extends AsyncModules {
         const validated = await this._validateResponse(result, schema('OrderEntitySchema'));
         return this._normalizeData(validated);
     }
+    /**
+     * Getting a single order created by the user, by its own id.
+     * @handleName getOrderById
+     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization. Unlike `getOrderByMarkerAndId`,
+     * it does not need the storage marker — use it when only the order id is at hand, for
+     * example on the return URL of a payment provider or in a link from a notification.
+     * @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/orders/getOrderById getOrderById} documentation.
+     */
+    async getOrderById(id, langCode = this.state.lang) {
+        const result = await this._withOrdersUrl(() => this._fetchGet(`/${id}?langCode=${langCode}`));
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('OrderEntitySchema'));
+        return this._normalizeData(validated);
+    }
     /**
      * Preview order calculation with discounts and coupons (without saving).
      * @handleName previewOrder

package/esm/orders/ordersInterfaces.d.ts

@@ -52,6 +52,17 @@ interface IOrdersApi {
      * @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}.
      */
     getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
+    /**
+     * Getting a single order created by the user, by its own id.
+     * @handleName getOrderById
+     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a single order by its own id, without the storage marker. 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}.
+     */
+    getOrderById(id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
     /**
      * Creation of an order in the order storage.
      * @handleName createOrder

package/esm/payments/paymentsApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules.js';
 import type StateModule from '../base/stateModule.js';
 import type { IError } from '../base/utils.js';
-import type { IAccountsEntity, IPaymentsApi, ISessionEntity, ISessionsEntity } from './paymentsInterfaces.js';
+import type { IAccountsEntity, IPaymentProgress, IPaymentsApi, ISessionEntity, ISessionsEntity } from './paymentsInterfaces.js';
 /**
  * Controllers for working with payments
  * @handle /api/content/payments
@@ -85,4 +85,17 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getAccountById getAccountById} documentation.
      */
     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 {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.
+     */
+    getPaymentStagesByOrderId(id: number): Promise<IPaymentProgress | IError>;
 }

package/esm/payments/paymentsApi.js

@@ -119,4 +119,22 @@ export default class PaymentsApi extends AsyncModules {
         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);
+    }
 }

package/esm/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/esm/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/esm/payments/paymentsSchemas.js

@@ -51,3 +51,22 @@ export const PaymentAccountSchema = z.object({
  * Payment accounts response schema
  */
 export const PaymentAccountsResponseSchema = z.array(PaymentAccountSchema);
+/**
+ * Payment stage schema
+ */
+export const PaymentStageSchema = z.object({
+    marker: z.string(),
+    sessionId: z.number(),
+    productId: z.number(),
+    title: z.string(),
+    value: z.number(),
+    status: z.enum(['planned', 'completed']),
+});
+/**
+ * Payment progress schema — stages of one order plus their aggregate state
+ */
+export const PaymentProgressSchema = z.object({
+    completed: z.boolean(),
+    partial: z.boolean(),
+    stages: z.array(PaymentStageSchema),
+});

package/esm/types.d.ts

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