oneentry 1.0.142 → 1.0.143

package/dist/pages/pagesInterfaces.d.ts

@@ -0,0 +1,284 @@
+import type { AttributeType, IAttributes, IError, ILocalizeInfo, LangType, Types } from '../base/utils';
+import type { IBlockEntity } from '../blocks/blocksInterfaces';
+import type { IFormConfig } from '../forms/formsInterfaces';
+import type { ITemplateEntity } from '../templates/templatesInterfaces';
+/**
+ * @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>;
+    /**
+     * Get settings for the page.
+     * @handleName getConfigPageByUrl
+     * @param {string} url - Page URL. Example: "about".
+     * @returns {IPageConfig} Returns a ConfigPage object with page display settings
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets settings for the page.
+     */
+    getConfigPageByUrl(url: string): Promise<IPageConfig | 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[]} 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 performs a quick search for page objects with limited output.
+     */
+    searchPage(name: string, url?: string, langCode?: LangType): Promise<IPagesEntity[] | IError>;
+}
+/**
+ * @interface IPageConfig
+ * @property {number | null} rowsPerPage - Number of lines per page. Example: 1.
+ * @property {number | null} productsPerRow - Number of products per page. Example: 1.
+ * @description This interface defines the configuration for pagination in pages, including the number of rows and products displayed per page.
+ */
+interface IPageConfig {
+    rowsPerPage: number | null;
+    productsPerRow: number | null;
+}
+/**
+ * @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 {Types} type - Page 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 {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @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.
+ * @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: string;
+    templateIdentifier: string | null;
+    isVisible: boolean;
+    isSync: boolean;
+    attributeValues: AttributeType;
+    countElementsPerRow?: number;
+    quantity?: number;
+}
+/**
+ * @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 {Types} 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 {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @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 {string} [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 {string} [total] - Total number of products linked to the page. Example: "10".
+ * @property {string} [categoryPath] - Category path string. Example: "catalog".
+ * @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: Types;
+    templateIdentifier: string | null;
+    attributeSetIdentifier: string | null;
+    attributeValues: AttributeType;
+    moduleFormConfigs?: IFormConfig[];
+    isSync: boolean;
+    template?: ITemplateEntity;
+    blocks?: IBlockEntity[] | string[];
+    position?: number;
+    config?: Record<string, number>;
+    products?: number;
+    childrenCount?: string;
+    total?: string;
+    categoryPath?: string;
+}
+export type { IPageConfig, IPagesApi, IPagesEntity, IPositionBlock, IPositionForm, };

package/dist/pages/pagesInterfaces.js

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

package/dist/pages/pagesSchemas.d.ts

@@ -0,0 +1,85 @@
+/**
+ * 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.ZodString;
+    templateIdentifier: z.ZodNullable<z.ZodString>;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    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.ZodString>;
+    total: z.ZodOptional<z.ZodString>;
+    categoryPath: z.ZodOptional<z.ZodString>;
+}, 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.ZodString;
+    templateIdentifier: z.ZodNullable<z.ZodString>;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    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.ZodString>;
+    total: z.ZodOptional<z.ZodString>;
+    categoryPath: z.ZodOptional<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.ZodString;
+    templateIdentifier: z.ZodNullable<z.ZodString>;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    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.ZodString>;
+    total: z.ZodOptional<z.ZodString>;
+    categoryPath: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Page config schema
+ */
+export declare const PageConfigSchema: z.ZodRecord<z.ZodString, z.ZodAny>;

package/dist/pages/pagesSchemas.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PageConfigSchema = exports.SinglePageSchema = exports.PagesResponseSchema = exports.PageEntitySchema = void 0;
+/**
+ * Validation schemas for Pages module
+ * @description Zod schemas for validating pages-related API responses
+ */
+const zod_1 = require("zod");
+/**
+ * Page entity schema
+ * Includes all fields returned by the API
+ */
+exports.PageEntitySchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    parentId: zod_1.z.number().nullable(),
+    pageUrl: zod_1.z.string(),
+    depth: zod_1.z.number(),
+    localizeInfos: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    isVisible: zod_1.z.boolean(),
+    type: zod_1.z.string(),
+    templateIdentifier: zod_1.z.string().nullable(),
+    attributeSetIdentifier: zod_1.z.string().nullable(),
+    attributeValues: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    moduleFormConfigs: zod_1.z.array(zod_1.z.any()).optional(),
+    isSync: zod_1.z.boolean(),
+    template: zod_1.z.any().optional(),
+    blocks: zod_1.z.union([zod_1.z.array(zod_1.z.any()), zod_1.z.array(zod_1.z.string())]).optional(),
+    position: zod_1.z.number().optional(),
+    config: zod_1.z.record(zod_1.z.string(), zod_1.z.number()).optional(),
+    products: zod_1.z.number().optional(),
+    childrenCount: zod_1.z.string().optional(),
+    total: zod_1.z.string().optional(),
+    categoryPath: zod_1.z.string().optional(),
+});
+/**
+ * Pages response schema (array of pages)
+ */
+exports.PagesResponseSchema = zod_1.z.array(exports.PageEntitySchema);
+/**
+ * Single page response schema
+ */
+exports.SinglePageSchema = exports.PageEntitySchema;
+/**
+ * Page config schema
+ */
+exports.PageConfigSchema = zod_1.z.record(zod_1.z.string(), zod_1.z.any());

package/dist/payments/paymentsApi.d.ts

@@ -0,0 +1,82 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IAccountsEntity, ICreateSessionEntity, IPaymentsApi, ISessionEntity, ISessionsEntity } from './paymentsInterfaces';
+/**
+ * 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}.
+     */
+    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}.
+     */
+    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}.
+     */
+    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<ICreateSessionEntity | 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}.
+     */
+    createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ICreateSessionEntity | 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}.
+     */
+    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}.
+     */
+    getAccountById(id: number): Promise<IAccountsEntity | IError>;
+}

package/dist/payments/paymentsApi.js

@@ -0,0 +1,121 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+const paymentsSchemas_1 = require("./paymentsSchemas");
+/**
+ * Controllers for working with payments
+ * @handle /api/content/payments
+ * @description Controllers for working with payments
+ */
+class PaymentsApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the PaymentsApi with a given state.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/payments';
+    }
+    /**
+     * 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}.
+     */
+    async getSessions(offset = 0, limit = 30) {
+        const query = {
+            offset,
+            limit,
+        };
+        const result = await this._fetchGet('/sessions/?' + this._queryParamsToString(query));
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, paymentsSchemas_1.PaymentSessionsResponseSchema);
+        return validated;
+    }
+    /**
+     * 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}.
+     */
+    async getSessionById(id) {
+        const result = await this._fetchGet(`/sessions/${id}`);
+        return result;
+    }
+    /**
+     * 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}.
+     */
+    async getSessionByOrderId(id) {
+        const result = await this._fetchGet(`/sessions/order/${id}`);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, paymentsSchemas_1.SinglePaymentSessionSchema);
+        return validated;
+    }
+    /**
+     * 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<ICreateSessionEntity | 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}.
+     */
+    async createSession(orderId, type, automaticTaxEnabled = false) {
+        const result = await this._fetchPost('/sessions', {
+            orderId,
+            type,
+            automaticTaxEnabled,
+        });
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, paymentsSchemas_1.CreateSessionResponseSchema);
+        return validated;
+    }
+    /**
+     * 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}.
+     */
+    async getAccounts() {
+        const result = await this._fetchGet('/accounts');
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, paymentsSchemas_1.PaymentAccountsResponseSchema);
+        return this._normalizeData(validated);
+    }
+    /**
+     * 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}.
+     */
+    async getAccountById(id) {
+        const result = await this._fetchGet(`/accounts/${id}`);
+        return this._normalizeData(result);
+    }
+}
+exports.default = PaymentsApi;