oneentry 1.0.159 → 1.0.161

package/esm/payments/paymentsApi.js

@@ -0,0 +1,122 @@
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./paymentsSchemas.js'));
+/**
+ * Controllers for working with payments
+ * @handle /api/content/payments
+ * @description Controllers for working with payments
+ */
+export default class PaymentsApi extends AsyncModules {
+    /**
+     * 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getSessions getSessions} documentation.
+     */
+    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 = await this._validateResponse(result, schema('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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getSessionById getSessionById} documentation.
+     */
+    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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getSessionByOrderId getSessionByOrderId} documentation.
+     */
+    async getSessionByOrderId(id) {
+        const result = await this._fetchGet(`/sessions/order/${id}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('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<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.
+     */
+    async createSession(orderId, type, automaticTaxEnabled = false) {
+        const result = await this._fetchPost('/sessions', {
+            orderId,
+            type,
+            automaticTaxEnabled,
+        });
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('PaymentSessionSchema'));
+        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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getAccounts getAccounts} documentation.
+     */
+    async getAccounts() {
+        const result = await this._fetchGet('/accounts');
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getAccountById getAccountById} documentation.
+     */
+    async getAccountById(id) {
+        const result = await this._fetchGet(`/accounts/${id}`);
+        return this._normalizeData(result);
+    }
+}

package/esm/payments/paymentsInterfaces.d.ts

@@ -0,0 +1,189 @@
+import type { IError, ILocalizeInfo } from '../base/utils.js';
+/**
+ * @interface IPaymentsApi
+ * @description This interface defines methods for managing payment sessions, accounts, and connected payment settings in the system.
+ */
+interface IPaymentsApi {
+    /**
+     * 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 {ISessionsEntity} Returns an array of SessionEntity objects.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @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 {ISessionEntity} Returns a single payment session object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @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 {ISessionEntity} Returns a single payment session object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @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 {ISessionEntity} Returns a single payment session object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @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<ISessionEntity | IError>;
+    /**
+     * Get all payment accounts as an array.
+     * @handleName getAccounts
+     * @returns {IAccountsEntity} Returns all created payment accounts as an array of PaymentAccountEntity objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @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 {IAccountsEntity} Returns a single payment account object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a single payment account 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}.
+     */
+    getAccountById(id: number): Promise<IAccountsEntity | IError>;
+}
+/**
+ * @interface ISessionsEntity
+ * @property {number} total - Total number of found records. Example: 100.
+ * @property {ISessionEntity[]} items - Array of session objects.
+ * @example
+    [
+      {
+        "id": 27,
+        "createdDate": "2025-06-04T04:38:32.849Z",
+        "updatedDate": "2025-06-04T04:38:32.849Z",
+        "type": "session",
+        "status": "waiting",
+        "paymentAccountId": 1,
+        "orderId": 55,
+        "paymentUrl": null
+      }
+    ]
+ * @description Represents a response from the payments API containing a total count and an array of session entities.
+ */
+interface ISessionsEntity {
+    total: number;
+    items: ISessionEntity[];
+}
+/**
+ * @interface ISessionEntity
+ * @property {number} id - Object identifier. Example: 1764.
+ * @property {string} createdDate - Object creation date. Example: "2025-02-26T10:13:16.839Z".
+ * @property {string} updatedDate - Object modification date. Example: "2025-02-26T10:13:16.839Z".
+ * @property {'session' | 'intent'} type - Type may be 'session' or 'intent'. Example: "session".
+ * @property {string} status - Payment status. Example: "completed".
+ * @property {number} paymentAccountId - Payment account identifier. Example: 1.
+ * @property {number} orderId - Order identifier. Example: 1.
+ * @property {string | null} paymentUrl - payment link. Example: " https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M".
+ * @property {number | null} [amount] - Amount of the payment session. Example: 100.
+ * @property {string} [clientSecret] - Client secret key returned by payment provider (e.g. Stripe) when creating a session. Example: "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH".
+ * @description This interface defines the structure of a session entity, including its quantity, amount, currency, name, and description.
+ */
+interface ISessionEntity {
+    id: number;
+    createdDate: string;
+    updatedDate: string;
+    type: 'session' | 'intent';
+    status: string;
+    paymentAccountId: number;
+    orderId: number;
+    paymentUrl: string | null;
+    amount?: number | null;
+    clientSecret?: string;
+}
+/**
+ * @interface IIntent
+ * @property {number} amount - Amount of the payment intent. Example: 100.00.
+ * @property {string} currency - Currency of the payment intent. Example: "USD".
+ * @description This interface defines the structure of a payment intent, including its amount and currency.
+ */
+interface IIntent {
+    amount: number;
+    currency: string;
+}
+/**
+ * @interface IAccountsEntity
+ * @property {number} id - Object identifier. Example: 12345.
+ * @property {ILocalizeInfo} localizeInfos - Json description of the payment account object.
+ * @property {string} identifier - Text identifier for the recording field. Example: "payment_12345".
+ * @property {'stripe' | 'yookassa' | 'midtrans' | 'xendit' | 'custom'} type - Payment provider type. Example: 'stripe'.
+ * @property {boolean} isVisible - Visibility indicator of the payment account. Example: true.
+ * @property {boolean} isUsed - Usage indicator of the payment account. Example: false.
+ * @property {boolean} testMode - Indicates whether the payment account is in test mode. Example: true.
+ * @property {IPaymentAccountSettings} settings - Payment account settings. Example: `{ "status": "connected" }`.
+ * @property {object} [testSettings] - Test mode settings for the payment account.
+ * @property {string} updatedDate - Object modification date. Example: "2025-02-26T10:13:16.839Z".
+ * @description This interface defines the structure of a payment account entity, including its identifiers, localization information, type, visibility, and usage status.
+ */
+interface IAccountsEntity {
+    id: number;
+    localizeInfos: ILocalizeInfo;
+    identifier: string;
+    type: 'stripe' | 'yookassa' | 'midtrans' | 'xendit' | 'custom';
+    isVisible: boolean;
+    isUsed: boolean;
+    testMode: boolean;
+    settings: IPaymentAccountSettings;
+    testSettings?: IPaymentAccountTestSettings;
+    updatedDate: string;
+}
+/**
+ * @interface IPaymentAccountSettings
+ * @property {string} status - Connection status of the live (non-test) payment account. Example: "connected".
+ * @description Live-mode configuration of a payment account; identical shape to test settings minus secrets.
+ */
+interface IPaymentAccountSettings {
+    status: string;
+}
+/**
+ * @interface IPaymentAccountTestSettings
+ * @property {string} status - Connection status of the test account. Example: "connected".
+ * @property {string} [cancelUrl] - URL the user is redirected to on payment cancellation.
+ * @property {string} [successUrl] - URL the user is redirected to on successful payment.
+ * @property {number} [sessionTimeout] - Stripe checkout session timeout in minutes. Example: 15.
+ * @property {string} [stripeAccountId] - Stripe-issued account identifier. Example: "acct_1QwkKrAcSoNc7iev".
+ * @property {string} [stripeRedirectUrl] - Stripe onboarding redirect URL.
+ * @property {boolean} [stripeOnboardingComplete] - Whether Stripe onboarding finished. Example: true.
+ * @property {string} [stripePublishableKey] - Stripe publishable key.
+ * @property {string} [signingSecretKey] - Stripe webhook signing secret. Example: "whsec_...".
+ * @property {boolean} [useWebHookValidation] - Whether incoming webhooks must be signature-validated. Example: true.
+ * @description Test-mode configuration of a payment account; field set depends on the provider (Stripe-specific fields are optional).
+ */
+interface IPaymentAccountTestSettings {
+    status: string;
+    cancelUrl?: string;
+    successUrl?: string;
+    sessionTimeout?: number;
+    stripeAccountId?: string;
+    stripeRedirectUrl?: string;
+    stripeOnboardingComplete?: boolean;
+    stripePublishableKey?: string;
+    signingSecretKey?: string;
+    useWebHookValidation?: boolean;
+}
+export type { IAccountsEntity, IIntent, IPaymentAccountSettings, IPaymentAccountTestSettings, IPaymentsApi, ISessionEntity, ISessionsEntity, };

package/esm/payments/paymentsInterfaces.js

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

package/esm/payments/paymentsSchemas.d.ts

@@ -0,0 +1,94 @@
+import { z } from 'zod';
+/**
+ * Payment session schema
+ * @description Zod schema for validating payment session responses
+ */
+export declare const PaymentSessionSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    orderId: z.ZodNumber;
+    amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    status: z.ZodString;
+    createdDate: z.ZodString;
+    updatedDate: z.ZodString;
+    type: z.ZodString;
+    paymentAccountId: z.ZodNumber;
+    paymentUrl: z.ZodNullable<z.ZodString>;
+    clientSecret: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Payment sessions response schema
+ * @description Paginated response schema for payment sessions
+ */
+export declare const PaymentSessionsResponseSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        orderId: z.ZodNumber;
+        amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        status: z.ZodString;
+        createdDate: z.ZodString;
+        updatedDate: z.ZodString;
+        type: z.ZodString;
+        paymentAccountId: z.ZodNumber;
+        paymentUrl: z.ZodNullable<z.ZodString>;
+        clientSecret: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Single payment session response schema
+ * @description Schema for a single payment session or array of sessions by order
+ */
+export declare const SinglePaymentSessionSchema: z.ZodUnion<readonly [z.ZodObject<{
+    id: z.ZodNumber;
+    orderId: z.ZodNumber;
+    amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    status: z.ZodString;
+    createdDate: z.ZodString;
+    updatedDate: z.ZodString;
+    type: z.ZodString;
+    paymentAccountId: z.ZodNumber;
+    paymentUrl: z.ZodNullable<z.ZodString>;
+    clientSecret: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    orderId: z.ZodNumber;
+    amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    status: z.ZodString;
+    createdDate: z.ZodString;
+    updatedDate: z.ZodString;
+    type: z.ZodString;
+    paymentAccountId: z.ZodNumber;
+    paymentUrl: z.ZodNullable<z.ZodString>;
+    clientSecret: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>>]>;
+/**
+ * Payment account schema
+ * @description Schema for a payment account
+ */
+export declare const PaymentAccountSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    isVisible: z.ZodBoolean;
+    isUsed: z.ZodBoolean;
+    testMode: z.ZodBoolean;
+    type: z.ZodString;
+    settings: z.ZodRecord<z.ZodString, z.ZodAny>;
+    testSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    updatedDate: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Payment accounts response schema
+ */
+export declare const PaymentAccountsResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    isVisible: z.ZodBoolean;
+    isUsed: z.ZodBoolean;
+    testMode: z.ZodBoolean;
+    type: z.ZodString;
+    settings: z.ZodRecord<z.ZodString, z.ZodAny>;
+    testSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    updatedDate: z.ZodString;
+}, z.core.$strip>>;

package/esm/payments/paymentsSchemas.js

@@ -0,0 +1,53 @@
+import { z } from 'zod';
+/**
+ * Payment session schema
+ * @description Zod schema for validating payment session responses
+ */
+export const PaymentSessionSchema = z.object({
+    id: z.number(),
+    orderId: z.number(),
+    amount: z.number().nullable().optional(),
+    status: z.string(),
+    createdDate: z.string(),
+    updatedDate: z.string(),
+    type: z.string(),
+    paymentAccountId: z.number(),
+    paymentUrl: z.string().nullable(),
+    clientSecret: z.string().optional(),
+});
+/**
+ * Payment sessions response schema
+ * @description Paginated response schema for payment sessions
+ */
+export const PaymentSessionsResponseSchema = z.object({
+    items: z.array(PaymentSessionSchema),
+    total: z.number(),
+});
+/**
+ * Single payment session response schema
+ * @description Schema for a single payment session or array of sessions by order
+ */
+export const SinglePaymentSessionSchema = z.union([
+    PaymentSessionSchema,
+    z.array(PaymentSessionSchema),
+]);
+/**
+ * Payment account schema
+ * @description Schema for a payment account
+ */
+export const PaymentAccountSchema = z.object({
+    id: z.number(),
+    identifier: z.string(),
+    isVisible: z.boolean(),
+    isUsed: z.boolean(),
+    testMode: z.boolean(),
+    type: z.string(),
+    settings: z.record(z.string(), z.any()),
+    testSettings: z.record(z.string(), z.any()).optional(),
+    localizeInfos: z.record(z.string(), z.any()),
+    updatedDate: z.string(),
+});
+/**
+ * Payment accounts response schema
+ */
+export const PaymentAccountsResponseSchema = z.array(PaymentAccountSchema);

package/esm/product-statuses/productStatusesApi.d.ts

@@ -0,0 +1,50 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IProductStatusEntity, IProductStatusesApi } from './productStatusesInterfaces.js';
+/**
+ * Controllers for working with product statuses
+ * @handle /api/content/product-statuses
+ * @description Controllers for working with product statuses
+ */
+export default class ProductStatusesApi extends AsyncModules implements IProductStatusesApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - State module instance
+     * @description Constructor initializes the ProductStatusesApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Search for all product status objects.
+     * @handleName getProductStatuses
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IProductStatusEntity[] | IError>} Returns an array of product status objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Search for all product status objects.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/getProductStatuses getProductStatuses} documentation.
+     */
+    getProductStatuses(langCode?: string): Promise<IProductStatusEntity[] | IError>;
+    /**
+     * Search for a product status object by its textual identifier (marker).
+     * @handleName getProductsByStatusMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Search for a product status object by its textual identifier (marker).
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/getProductsByStatusMarker getProductsByStatusMarker} documentation.
+     */
+    getProductsByStatusMarker(marker: string, langCode?: string): Promise<IProductStatusEntity | IError>;
+    /**
+     * Check the existence of a textual identifier.
+     * @handleName validateMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @returns {Promise<boolean | IError>} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Check the existence of a textual identifier.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/validateMarker validateMarker} documentation.
+     */
+    validateMarker(marker: string): Promise<boolean | IError>;
+}

package/esm/product-statuses/productStatusesApi.js

@@ -0,0 +1,68 @@
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./productStatusesSchemas.js'));
+/**
+ * Controllers for working with product statuses
+ * @handle /api/content/product-statuses
+ * @description Controllers for working with product statuses
+ */
+export default class ProductStatusesApi extends AsyncModules {
+    /**
+     * Constructor
+     * @param {StateModule} state - State module instance
+     * @description Constructor initializes the ProductStatusesApi with a given state.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/product-statuses';
+    }
+    /**
+     * Search for all product status objects.
+     * @handleName getProductStatuses
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IProductStatusEntity[] | IError>} Returns an array of product status objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Search for all product status objects.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/getProductStatuses getProductStatuses} documentation.
+     */
+    async getProductStatuses(langCode = this.state.lang) {
+        const result = await this._fetchGet('');
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('ProductStatusesResponseSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Search for a product status object by its textual identifier (marker).
+     * @handleName getProductsByStatusMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Search for a product status object by its textual identifier (marker).
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/getProductsByStatusMarker getProductsByStatusMarker} documentation.
+     */
+    async getProductsByStatusMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/marker/${marker}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('ProductStatusEntitySchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Check the existence of a textual identifier.
+     * @handleName validateMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @returns {Promise<boolean | IError>} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Check the existence of a textual identifier.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/validateMarker validateMarker} documentation.
+     */
+    async validateMarker(marker) {
+        const result = await this._fetchGet(`/marker-validation/${marker}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('ValidateMarkerResponseSchema'));
+        // Extract the 'valid' boolean value from the response object
+        return typeof validated === 'object' && 'valid' in validated
+            ? validated.valid
+            : validated;
+    }
+}

package/esm/product-statuses/productStatusesInterfaces.d.ts

@@ -0,0 +1,62 @@
+import type { IError, ILocalizeInfo } from '../base/utils.js';
+/**
+ * @interface IProductStatuses
+ * @description This interface defines methods for retrieving and managing product statuses in the system.
+ */
+interface IProductStatusesApi {
+    /**
+     * Search for all product status objects.
+     * @handleName getProductStatuses
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IProductStatusEntity[]} Returns an array of product status objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for all product status objects.
+     */
+    getProductStatuses(langCode: string): Promise<IProductStatusEntity[] | IError>;
+    /**
+     * Search for a product status object by its textual identifier (marker).
+     * @handleName getProductsByStatusMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IProductStatusEntity} Returns a product status object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for a product status object by its textual identifier (marker).
+     */
+    getProductsByStatusMarker(marker: string, langCode: string): Promise<IProductStatusEntity | IError>;
+    /**
+     * Check the existence of a textual identifier.
+     * @handleName validateMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @returns {boolean} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method checks the existence of a textual identifier.
+     */
+    validateMarker(marker: string): Promise<boolean | IError>;
+}
+/**
+ * Product status entity structure
+ * @interface IProductStatusEntity
+ * @property {number} id - The unique identifier of the position. Example: 12345.
+ * @property {string} identifier - The textual identifier for the record field. Example: "in_stock".
+ * @property {ILocalizeInfo} localizeInfos - The name of the products statuses, taking into account localization.
+ * @example
+    {
+      "title": "Catalog",
+      "plainContent": "Content for catalog",
+      "htmlContent": "<b>Content for catalog</b>",
+      "menuTitle": "Catalog"
+    }
+ * @property {boolean} isDefault - Default status flag. Example: true.
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {number} position - Position number. Example: 1.
+ * @description This interface defines the structure of a product status entity, including its identifiers, localization information, position, and default status flag.
+ */
+interface IProductStatusEntity {
+    id: number;
+    identifier: string;
+    localizeInfos: ILocalizeInfo;
+    isDefault: boolean;
+    version: number;
+    position: number;
+}
+export type { IProductStatusEntity, IProductStatusesApi };

package/esm/product-statuses/productStatusesInterfaces.js

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