oneentry 1.0.160 → 1.0.162

package/esm/pages/pagesInterfaces.d.ts

@@ -0,0 +1,327 @@
+import type { IAttributes, IAttributeValues, IError, ILocalizeInfo, IRating, LangType } from '../base/utils.js';
+import type { BlockType, IBlockEntity } from '../blocks/blocksInterfaces.js';
+import type { IFormConfig } from '../forms/formsInterfaces.js';
+import type { IProductsEntity, IProductsResponse } from '../products/productsInterfaces.js';
+import type { ITemplateEntity } from '../templates/templatesInterfaces.js';
+/**
+ * @interface IPagesApi
+ * @description This interface defines methods for retrieving and managing pages in the system.
+ */
+interface IPagesApi {
+    /**
+     * Get all top-level page objects.
+     * @handleName getRootPages
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IPagesEntity[]} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all top-level page objects.
+     */
+    getRootPages(langCode?: LangType): Promise<IPagesEntity[] | IError>;
+    /**
+     * Get all page objects with product information as an array.
+     * @handleName getPages
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all page objects with product information as an array.
+     */
+    getPages(langCode?: LangType): Promise<IPagesEntity[] | IError>;
+    /**
+     * Get page object with information about forms, blocks, menus, linked to the page.
+     * @handleName getPageById
+     * @param {number} id - The unique identifier of the page to be fetched. Example: 123.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a page object with information about forms, blocks, menus, linked to the page.
+     */
+    getPageById(id: number, langCode?: LangType): Promise<IPagesEntity | IError>;
+    /**
+     * Get page object with information about forms, blocks, menus, linked to the page by URL.
+     * @handleName getPageByUrl
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a page object with information about forms, blocks, menus, linked to the page by URL.
+     */
+    getPageByUrl(url: string, langCode?: LangType): Promise<IPagesEntity | IError>;
+    /**
+     * Get child pages object with information as an array.
+     * @handleName getChildPagesByParentUrl
+     * @param {string} url - The URL of the parent page for which child pages are to be fetched. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IPagesEntity} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets child pages object with information as an array.
+     */
+    getChildPagesByParentUrl(url: string, langCode?: LangType): Promise<IPagesEntity[] | IError>;
+    /**
+     * Get all blocks by page url.
+     * @handleName getBlocksByPageUrl
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IPositionBlock[]} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all blocks by page url.
+     */
+    getBlocksByPageUrl(url: string, langCode?: LangType): Promise<IPositionBlock[] | IError>;
+    /**
+     * Quick search for page objects with limited output.
+     * @handleName searchPage
+     * @param {string} name - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account). Example: "About Us".
+     * @param {string} [url] - Optional page URL to filter search results. Example: "catalog".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IPagesEntity[] | IPageSearchResult[]} Returns found pages as an array of PageEntity objects, an array of short PageSearchResult cards when the traficLimit config option is enabled, or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method performs a quick search for page objects with limited output. With traficLimit enabled the raw quick search response is returned as short cards; otherwise full page entities are fetched for the found ids.
+     */
+    searchPage(name: string, url?: string, langCode?: LangType): Promise<IPagesEntity[] | IPageSearchResult[] | IError>;
+    /**
+     * Semantic (vector) search for pages.
+     * @handleName getPagesByVectorSearch
+     * @param {IPagesVectorSearch} body - Vector search body. Example: `{ queryText: "winter sale" }`.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {IPagesResponse} A promise that resolves to a pages response (items + total) or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method performs a semantic (vector) search for pages.
+     */
+    getPagesByVectorSearch(body: IPagesVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IPagesResponse | IError>;
+}
+/**
+ * Body for semantic (vector) page search.
+ * @interface IPagesVectorSearch
+ * @property {string} queryText - Natural-language search query. Example: "winter sale".
+ * @property {number} [vectorDistanceThreshold] - Override of the cosine distance threshold (0..2). Example: 0.3.
+ * @property {number} [maxHits] - Top-K candidates fetched before pagination. Default: 100. Max: 500. Example: 10.
+ * @property {boolean} [debug] - When true, each returned item gets a `distance` field. Example: false.
+ * @description Body for the pages vector/search endpoint.
+ */
+interface IPagesVectorSearch {
+    queryText: string;
+    vectorDistanceThreshold?: number;
+    maxHits?: number;
+    debug?: boolean;
+}
+/**
+ * @interface IPagesResponse
+ * @property {IPagesEntity[]} items - Array of found page objects.
+ * @property {number} total - Total number of found records. Example: 100.
+ * @description This interface defines the structure of a response containing multiple page entities, including the total count and an array of page items.
+ */
+interface IPagesResponse {
+    items: IPagesEntity[];
+    total: number;
+}
+/**
+ * @interface IPositionForm
+ * @property {number} id - The identifier of the object. Example: 1764.
+ * @property {number} version - The version number of the object. Example: 10.
+ * @property {string} identifier - The textual identifier for the record field. Example: "catalog".
+ * @property {number} attributeSetId - The identifier of the attribute set being used. Example: 0.
+ * @property {string} processingType - Type of form processing. Example: "email".
+ * @property {ILocalizeInfo} localizeInfos  - The name of the page, taking into account localization.
+ * @example
+    {
+      "title": "Blog",
+      "menuTitle": "Blog",
+      "htmlContent": "",
+      "plainContent": ""
+    }
+ * @property {object} processingData - Form data. Example: {}.
+ * @property {number} position - The position of the object. Example: 0.
+ * @property {IAttributes[]} attributes - Array of attribute values from the used attribute set for displaying the form (taking into account the specified language).
+ * @example
+    [
+      {
+        "type": "list",
+        "marker": "list_marker",
+        "position": 2,
+        "listTitles": [
+          {
+            "title": "red",
+            "value": 1,
+            "position": 1,
+            "extendedValue": null,
+            "extendedValueType": null
+          },
+          {
+            "title": "yellow",
+            "value": 2,
+            "position": 2,
+            "extendedValue": null,
+            "extendedValueType": null
+          }
+        ],
+        "validators": {},
+        "localizeInfos": {
+        "title": "l1"
+      }
+    ]
+ * @description This interface defines the structure of a position form entity, including its identifiers, attributes, and processing data.
+ */
+interface IPositionForm {
+    id: number;
+    version: number;
+    identifier: string;
+    attributeSetId: number;
+    processingType: string;
+    localizeInfos: ILocalizeInfo;
+    processingData: Record<string, any>;
+    position: number;
+    attributes: IAttributes[] | IAttributes;
+}
+/**
+ * @interface IPositionBlock
+ * @property {number} id - The identifier of the object. Example: 1.
+ * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "block".
+ * @property {ILocalizeInfo} localizeInfos - The name of the page, taking into account localization.
+ * @example
+    {
+      "title": "Blog",
+      "menuTitle": "Blog",
+      "htmlContent": "",
+      "plainContent": ""
+    }
+ * @property {number} version - The version number of the object. Example: 0.
+ * @property {number} position - The position of the object. Example: 1.
+ * @property {string} identifier - The textual identifier for the record field. Example: "product_block".
+ * @property {BlockType} type - Block type. Example: "product".
+ * @property {string | null} templateIdentifier     - User id of the linked template. Example: null.
+ * @property {boolean} isVisible - A sign of page visibility. Example: true.
+ * @property {boolean} isSync - Indication of page indexing. Example: false.
+ * @property {IAttributeValues} attributeValues - Map of attribute values keyed by marker; empty object when none.
+ * @example
+    {
+      "block-text": {
+        "type": "string",
+        "value": "some text",
+        "position": 0,
+        "additionalFields": []
+      }
+    }
+ * @property {number} [countElementsPerRow] - Number of elements displayed per row in the block, if applicable. Example: 3.
+ * @property {number} [quantity] - Quantity pages in block. Example: 1.
+ * @property {IProductsResponse} [similarProducts] - Similar products response (total + items). Present only for "similar_products_block" blocks and only when traffic-saving mode is off.
+ * @property {IProductsEntity[]} [products] - Array of products associated with the block. Present only for "product_block" blocks and only when traffic-saving mode is off.
+ * @description This interface defines the structure of a position block entity, including its identifiers, attributes, and visibility.
+ */
+interface IPositionBlock {
+    id: number;
+    attributeSetIdentifier: string | null;
+    localizeInfos: ILocalizeInfo;
+    version: number;
+    position: number;
+    identifier: string;
+    type: BlockType;
+    templateIdentifier: string | null;
+    isVisible: boolean;
+    isSync: boolean;
+    attributeValues: IAttributeValues;
+    countElementsPerRow?: number;
+    quantity?: number;
+    similarProducts?: IProductsResponse;
+    products?: IProductsEntity[];
+}
+/**
+ * PageType
+ * @type {PageType}
+ * @description This type defines the possible values for page types used in the system. It is a page-specific subset of {@link BlockType}.
+ */
+type PageType = 'catalog_page' | 'common_page' | 'error_page' | 'external_page';
+/**
+ * @interface IPagesEntity
+ * @property {number} id - The identifier of the object. Example: 8.
+ * @property {number | null} parentId - The id of the parent page, if it contains null, then it is the top-level page. Example: 10.
+ * @property {string} pageUrl - Unique page Url. Example: "blog".
+ * @property {number} depth - Page nesting depth relative to parentId. Example: 10.
+ * @property {ILocalizeInfo} localizeInfos - The name of the page, taking into account localization.
+ * @example
+    {
+      "title": "Blog",
+      "menuTitle": "Blog",
+      "htmlContent": "",
+      "plainContent": ""
+    }
+ * @property {boolean} isVisible - A sign of page visibility. Example: true.
+ * @property {PageType} type - Page type. Example: "common_page".
+ * @property {string | null} templateIdentifier - User id of the linked template. Example: "template".
+ * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "page".
+ * @property {IAttributeValues} attributeValues - Map of attribute values keyed by marker; empty object when none.
+ * @example
+    {
+      "text": {
+        "type": "string",
+        "value": "some text",
+        "position": 0,
+        "additionalFields": []
+      }
+    }
+ * @property {boolean} isSync - Indication of page indexing. Example: true.
+ * @property {object} [template] - Template object. Example: {}.
+ * @property {number} [position] - Item number (for sorting). Example: 2.
+ * @property {Record<string, number>} [config] - Output settings for catalog pages.
+ * @example
+    {
+      "rowsPerPage": 1,
+      "productsPerRow": 1
+    }
+ * @property {number} [products] - The number of products linked to the page. Example: 0.
+ * @property {number} [childrenCount] - Children count. Example: 1.
+ * @property {IBlockEntity[] | string[]} [blocks] - blocks.
+ * @example
+    {
+      "id": 4,
+      "attributeSetIdentifier": null,
+      "title": "Template",
+      "generalTypeId": 4,
+      "identifier": "template",
+      "version": 0,
+      "generalTypeName": "catalog_page",
+      "attributeValues": {},
+      "position": 1
+    }
+ * @property {Array<IFormConfig>} [moduleFormConfigs] - Module form configurations linked to the page.
+ * @property {IRating} [rating] - Rating data.
+ * @property {string} [total] - Total number of products linked to the page. Example: "10".
+ * @property {string | null} [categoryPath] - Category path string; null for nested pages that have no own category path. Example: "catalog".
+ * @property {number} [distance] - Cosine distance to the query. Returned only by the semantic (vector) search endpoint when `debug: true` is passed in the search body. Example: 0.12.
+ * @description This interface defines the structure of a page entity, including its identifiers, attributes, and hierarchical relationships.
+ */
+interface IPagesEntity {
+    id: number;
+    parentId: number | null;
+    pageUrl: string;
+    depth: number;
+    localizeInfos: ILocalizeInfo;
+    isVisible: boolean;
+    type: PageType;
+    templateIdentifier: string | null;
+    attributeSetIdentifier: string | null;
+    attributeValues: IAttributeValues;
+    moduleFormConfigs?: IFormConfig[];
+    rating?: IRating;
+    isSync: boolean;
+    template?: ITemplateEntity;
+    blocks?: IBlockEntity[] | string[];
+    position?: number;
+    config?: Record<string, number>;
+    products?: number;
+    childrenCount?: number;
+    total?: string;
+    categoryPath?: string | null;
+    distance?: number;
+}
+/**
+ * @interface IPageSearchResult
+ * @property {number} id - The identifier of the page. Example: 10.
+ * @property {string} title - Page title in the requested language. Example: "Catalog".
+ * @description This interface defines the short page card returned by the quick search endpoint when the traficLimit config option is enabled. It contains only identification fields, without attributeValues, localizeInfos, blocks and other fields of a full page entity.
+ */
+interface IPageSearchResult {
+    id: number;
+    title: string;
+}
+export type { IPagesApi, IPageSearchResult, IPagesEntity, IPagesResponse, IPagesVectorSearch, IPositionBlock, IPositionForm, PageType, };

package/esm/pages/pagesInterfaces.js

@@ -0,0 +1 @@
+export {};

package/esm/pages/pagesSchemas.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Validation schemas for Pages module
+ * @description Zod schemas for validating pages-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Page entity schema
+ * Includes all fields returned by the API
+ */
+export declare const PageEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    parentId: z.ZodNullable<z.ZodNumber>;
+    pageUrl: z.ZodString;
+    depth: z.ZodNumber;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    isVisible: z.ZodBoolean;
+    type: z.ZodEnum<{
+        error_page: "error_page";
+        catalog_page: "catalog_page";
+        common_page: "common_page";
+        external_page: "external_page";
+    }>;
+    templateIdentifier: z.ZodNullable<z.ZodString>;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    isSync: z.ZodBoolean;
+    template: z.ZodOptional<z.ZodAny>;
+    blocks: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodArray<z.ZodString>]>>;
+    position: z.ZodOptional<z.ZodNumber>;
+    config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    products: z.ZodOptional<z.ZodNumber>;
+    childrenCount: z.ZodOptional<z.ZodNumber>;
+    total: z.ZodOptional<z.ZodString>;
+    categoryPath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    distance: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * Pages response schema (array of pages)
+ */
+export declare const PagesResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    parentId: z.ZodNullable<z.ZodNumber>;
+    pageUrl: z.ZodString;
+    depth: z.ZodNumber;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    isVisible: z.ZodBoolean;
+    type: z.ZodEnum<{
+        error_page: "error_page";
+        catalog_page: "catalog_page";
+        common_page: "common_page";
+        external_page: "external_page";
+    }>;
+    templateIdentifier: z.ZodNullable<z.ZodString>;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    isSync: z.ZodBoolean;
+    template: z.ZodOptional<z.ZodAny>;
+    blocks: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodArray<z.ZodString>]>>;
+    position: z.ZodOptional<z.ZodNumber>;
+    config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    products: z.ZodOptional<z.ZodNumber>;
+    childrenCount: z.ZodOptional<z.ZodNumber>;
+    total: z.ZodOptional<z.ZodString>;
+    categoryPath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    distance: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>>;
+/**
+ * Page search result schema
+ * Short card returned by the quick search endpoint
+ */
+export declare const PageSearchResultSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    title: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Page search response schema (array of short cards)
+ */
+export declare const PageSearchResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    title: z.ZodString;
+}, z.core.$strip>>;
+/**
+ * Single page response schema
+ */
+export declare const SinglePageSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    parentId: z.ZodNullable<z.ZodNumber>;
+    pageUrl: z.ZodString;
+    depth: z.ZodNumber;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    isVisible: z.ZodBoolean;
+    type: z.ZodEnum<{
+        error_page: "error_page";
+        catalog_page: "catalog_page";
+        common_page: "common_page";
+        external_page: "external_page";
+    }>;
+    templateIdentifier: z.ZodNullable<z.ZodString>;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    isSync: z.ZodBoolean;
+    template: z.ZodOptional<z.ZodAny>;
+    blocks: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodArray<z.ZodString>]>>;
+    position: z.ZodOptional<z.ZodNumber>;
+    config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    products: z.ZodOptional<z.ZodNumber>;
+    childrenCount: z.ZodOptional<z.ZodNumber>;
+    total: z.ZodOptional<z.ZodString>;
+    categoryPath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    distance: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;

package/esm/pages/pagesSchemas.js

@@ -0,0 +1,54 @@
+/**
+ * Validation schemas for Pages module
+ * @description Zod schemas for validating pages-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Page entity schema
+ * Includes all fields returned by the API
+ */
+export const PageEntitySchema = z.object({
+    id: z.number(),
+    parentId: z.number().nullable(),
+    pageUrl: z.string(),
+    depth: z.number(),
+    localizeInfos: z.record(z.string(), z.any()),
+    isVisible: z.boolean(),
+    // Must stay in sync with PageType in src/pages/pagesInterfaces.ts
+    type: z.enum(['catalog_page', 'common_page', 'error_page', 'external_page']),
+    templateIdentifier: z.string().nullable(),
+    attributeSetIdentifier: z.string().nullable(),
+    attributeValues: z.record(z.string(), z.any()),
+    moduleFormConfigs: z.array(z.any()).optional(),
+    rating: z.record(z.string(), z.unknown()).optional(),
+    isSync: z.boolean(),
+    template: z.any().optional(),
+    blocks: z.union([z.array(z.any()), z.array(z.string())]).optional(),
+    position: z.number().optional(),
+    config: z.record(z.string(), z.number()).optional(),
+    products: z.number().optional(),
+    childrenCount: z.number().optional(),
+    total: z.string().optional(),
+    categoryPath: z.string().nullable().optional(),
+    distance: z.number().optional(),
+});
+/**
+ * Pages response schema (array of pages)
+ */
+export const PagesResponseSchema = z.array(PageEntitySchema);
+/**
+ * Page search result schema
+ * Short card returned by the quick search endpoint
+ */
+export const PageSearchResultSchema = z.object({
+    id: z.number(),
+    title: z.string(),
+});
+/**
+ * Page search response schema (array of short cards)
+ */
+export const PageSearchResponseSchema = z.array(PageSearchResultSchema);
+/**
+ * Single page response schema
+ */
+export const SinglePageSchema = PageEntitySchema;

package/esm/payments/paymentsApi.d.ts

@@ -0,0 +1,88 @@
+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';
+/**
+ * Controllers for working with payments
+ * @handle /api/content/payments
+ * @description Controllers for working with payments
+ */
+export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the PaymentsApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get list of payment sessions.
+     * @handleName getSessions
+     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [limit]  - Optional parameter for pagination. Default: 30.
+     * @returns {Promise<ISessionsEntity | IError>} Returns an array of SessionEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method gets list of payment sessions. 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/getSessions getSessions} documentation.
+     */
+    getSessions(offset?: number, limit?: number): Promise<ISessionsEntity | IError>;
+    /**
+     * Get a single payment session object by its identifier.
+     * @handleName getSessionById
+     * @param {number} id - Identifier of the retrieved payment session object. Example: 12345.
+     * @returns {Promise<ISessionEntity | IError>} Returns a single payment session object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method gets a single payment session object by its identifier. 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/getSessionById getSessionById} documentation.
+     */
+    getSessionById(id: number): Promise<ISessionEntity | IError>;
+    /**
+     * Get one payment session object by order identifier
+     * @handleName getSessionByOrderId
+     * @param {number} id - Order identifier. Example: 12345.
+     * @returns {Promise<IAccountsEntity | IError>} Returns a single payment account object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method gets one payment session object by order identifier. 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/getSessionByOrderId getSessionByOrderId} documentation.
+     */
+    getSessionByOrderId(id: number): Promise<ISessionEntity | ISessionEntity[] | IError>;
+    /**
+     * Creation of payment session.
+     * @handleName createSession
+     * @param {number} orderId - Order identifier. Example: 12345.
+     * @param {'session' | 'intent'} type - Session type. Possible values: "session" or "intent". Example:  'session'.
+     * @param {boolean} [automaticTaxEnabled] - Automatic calculation of the tax rate. Default: false.
+     * @returns {Promise<ISessionEntity | IError>} Returns a single payment session object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method creates a payment session. 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/createSession createSession} documentation.
+     */
+    createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ISessionEntity | IError>;
+    /**
+     * Get all payment accounts as an array.
+     * @handleName getAccounts
+     * @returns {Promise<IAccountsEntity | IError>} Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method gets all payment accounts as an array. 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/getAccounts getAccounts} documentation.
+     */
+    getAccounts(): Promise<IAccountsEntity[] | IError>;
+    /**
+     * Get a single payment account object by its identifier.
+     * @handleName getAccountById
+     * @param {number} id - Identifier of the retrieved payment account object. Example: 12345.
+     * @returns {Promise<IAccountsEntity | IError>} Returns a single payment account object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get a single payment account object by its identifier.
+     * @description 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/getAccountById getAccountById} documentation.
+     */
+    getAccountById(id: number): Promise<IAccountsEntity | IError>;
+}