oneentry 1.0.139 → 1.0.141

package/README.md

@@ -18,6 +18,16 @@ To install the OneEntry SDK in your project, run the following command:
 npm install oneentry
 ```
 
+## Quick Start with CLI
+
+After installation, run the interactive setup tool to generate a working example and see live data from your project:
+
+```bash
+npx oneentry
+```
+
+It will ask for your project URL and API token, generate an `example.mjs` file, and optionally run it immediately — printing admins, pages and products to the console.
+
 ## Get Started
 
 To use the OneEntry SDK in your project, import the defineOneEntry function:
@@ -33,18 +43,21 @@ const {
     AttributesSets,
     AuthProvider,
     Blocks,
+    Discounts,
     Events,
+    FileUploading,
     Forms,
     FormData,
-    FileUploading,
     GeneralTypes,
     IntegrationCollections,
     Locales,
     Menus,
     Orders,
     Pages,
+    Payments,
     Products,
     ProductStatuses,
+    Sitemap,
     System,
     Templates,
     TemplatePreviews,
@@ -202,6 +215,7 @@ Now you can use the following links to jump to specific entries documentation:
 - [AttributesSets](https://js-sdk.oneentry.cloud/docs/category/attributessets)
 - [AuthProvider](https://js-sdk.oneentry.cloud/docs/category/authprovider)
 - [Blocks](https://js-sdk.oneentry.cloud/docs/category/blocks)
+- [Discounts](https://js-sdk.oneentry.cloud/docs/category/discounts)
 - [Events](https://js-sdk.oneentry.cloud/docs/category/events)
 - [FileUploading](https://js-sdk.oneentry.cloud/docs/category/fileuploading)
 - [Forms](https://js-sdk.oneentry.cloud/docs/category/forms-1)
@@ -215,6 +229,7 @@ Now you can use the following links to jump to specific entries documentation:
 - [Payments](https://js-sdk.oneentry.cloud/docs/category/payments)
 - [ProductStatuses](https://js-sdk.oneentry.cloud/docs/category/productstatuses)
 - [Products](https://js-sdk.oneentry.cloud/docs/category/products-1)
+- [Sitemap](https://js-sdk.oneentry.cloud/docs/category/sitemap)
 - [System](https://js-sdk.oneentry.cloud/docs/category/system)
 - [Templates](https://js-sdk.oneentry.cloud/docs/category/templates)
 - [TemplatePreviews](https://js-sdk.oneentry.cloud/docs/category/templatepreviews)

package/configure.js

@@ -22,50 +22,69 @@
 /* eslint-disable @typescript-eslint/no-require-imports */
 
 const fs = require('fs');
-// const path = require('path');
-
 const readline = require('readline');
+const { spawn } = require('child_process');
 
 const rl = readline.createInterface({
   input: process.stdin,
   output: process.stdout,
 });
 
-rl.question('Enter project name with https://... : ', (name) => {
+rl.question('Enter project name with https://... : ', (url) => {
   rl.question('Enter token: ', (token) => {
-    rl.close();
-    createInterface(name, token);
+    rl.question('Run example after creating? (y/n): ', (answer) => {
+      rl.close();
+      createInterface(url, token, answer.trim().toLowerCase() === 'y');
+    });
   });
 });
 
 /**
- * Creates an example TypeScript interface file with SDK configuration
- *
- * Generates an example.ts file containing a BuildInterface type and
- * IAttributesList interface with the provided project name and token.
+ * Creates an example JavaScript file with SDK initialization and sample requests
  *
- * @param {string} name - Project URL with https:// (e.g., "https://example.oneentry.cloud")
+ * Generates an example.mjs file with a ready-to-use defineOneEntry call
+ * that fetches admins, pages and products and prints them to the console.
+ * Run with: node example.mjs
+ * @param {string} url - Project URL with https:// (e.g., "https://example.oneentry.cloud")
  * @param {string} token - Authentication token for API access
+ * @param {boolean} run - Whether to run the generated file immediately
  */
-function createInterface(name, token) {
-  const filePath = 'example.ts';
+function createInterface(url, token, run) {
+  const filePath = 'example.mjs';
+  const tokenLine = token ? `\n  token: '${token}',` : '';
   fs.writeFile(
     filePath,
-    `
-      type BuildInterface<T extends string[]> = {
-          [K in T[number]]: string | undefined;
-      }
-      interface IAttributesList extends BuildInterface<['${name}', '${token}', 'value3']> {}
-      export {
-          IAttributesList
-      }
-    `,
+    `import { defineOneEntry } from 'oneentry';
+
+const { Admins, Pages, Products } = defineOneEntry('${url}', {${tokenLine}
+  langCode: 'en_US',
+});
+
+const [admins, pages, products] = await Promise.all([
+  Admins.getAdminsInfo(),
+  Pages.getPages(),
+  Products.getProducts(),
+]);
+
+console.log('Admins:', JSON.stringify(admins, null, 2));
+console.log('Pages:', JSON.stringify(pages, null, 2));
+console.log('Products:', JSON.stringify(products, null, 2));
+`,
     (err) => {
       if (err) {
         console.error(err);
         return;
       }
       console.log(`Successfully created ${filePath}`);
+      if (!run) {
+        console.log(`Run it with: node ${filePath}`);
+        return;
+      }
+      console.log(`Running ${filePath}...\n`);
+      const child = spawn('node', [filePath], { stdio: 'inherit' });
+      child.on('error', (e) =>
+        console.error('Failed to run script:', e.message),
+      );
     },
   );
 }

package/dist/auth-provider/authProviderSchemas.d.ts

@@ -70,17 +70,14 @@ export declare const UserResponseSchema: z.ZodObject<{
 export declare const AuthProviderEntitySchema: z.ZodObject<{
     id: z.ZodNumber;
     identifier: z.ZodString;
-    type: z.ZodOptional<z.ZodString>;
-    formIdentifier: z.ZodOptional<z.ZodString>;
-    userGroupIdentifier: z.ZodOptional<z.ZodString>;
+    type: z.ZodString;
+    formIdentifier: z.ZodNullable<z.ZodString>;
+    userGroupIdentifier: z.ZodString;
     isActive: z.ZodBoolean;
-    isCheckCode: z.ZodOptional<z.ZodBoolean>;
-    version: z.ZodOptional<z.ZodNumber>;
-    localizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    marker: z.ZodOptional<z.ZodString>;
-    name: z.ZodOptional<z.ZodString>;
-    position: z.ZodOptional<z.ZodNumber>;
+    isCheckCode: z.ZodBoolean;
+    version: z.ZodNumber;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    config: z.ZodRecord<z.ZodString, z.ZodAny>;
 }, z.core.$strip>;
 /**
  * Auth providers list response schema
@@ -89,17 +86,14 @@ export declare const AuthProviderEntitySchema: z.ZodObject<{
 export declare const AuthProvidersResponseSchema: z.ZodArray<z.ZodObject<{
     id: z.ZodNumber;
     identifier: z.ZodString;
-    type: z.ZodOptional<z.ZodString>;
-    formIdentifier: z.ZodOptional<z.ZodString>;
-    userGroupIdentifier: z.ZodOptional<z.ZodString>;
+    type: z.ZodString;
+    formIdentifier: z.ZodNullable<z.ZodString>;
+    userGroupIdentifier: z.ZodString;
     isActive: z.ZodBoolean;
-    isCheckCode: z.ZodOptional<z.ZodBoolean>;
-    version: z.ZodOptional<z.ZodNumber>;
-    localizeInfos: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    marker: z.ZodOptional<z.ZodString>;
-    name: z.ZodOptional<z.ZodString>;
-    position: z.ZodOptional<z.ZodNumber>;
+    isCheckCode: z.ZodBoolean;
+    version: z.ZodNumber;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    config: z.ZodRecord<z.ZodString, z.ZodAny>;
 }, z.core.$strip>>;
 /**
  * Generate code response schema
@@ -122,16 +116,16 @@ export declare const LogoutResponseSchema: z.ZodObject<{
  * @description Schema for validating active sessions response
  */
 export declare const ActiveSessionSchema: z.ZodObject<{
-    id: z.ZodString;
-    deviceInfo: z.ZodOptional<z.ZodString>;
-    ipAddress: z.ZodOptional<z.ZodString>;
-    lastActive: z.ZodOptional<z.ZodString>;
-    createdAt: z.ZodString;
+    deviceInfo: z.ZodObject<{
+        os: z.ZodString;
+        browser: z.ZodString;
+        location: z.ZodString;
+    }, z.core.$strip>;
 }, z.core.$strip>;
 export declare const ActiveSessionsResponseSchema: z.ZodArray<z.ZodObject<{
-    id: z.ZodString;
-    deviceInfo: z.ZodOptional<z.ZodString>;
-    ipAddress: z.ZodOptional<z.ZodString>;
-    lastActive: z.ZodOptional<z.ZodString>;
-    createdAt: z.ZodString;
+    deviceInfo: z.ZodObject<{
+        os: z.ZodString;
+        browser: z.ZodString;
+        location: z.ZodString;
+    }, z.core.$strip>;
 }, z.core.$strip>>;

package/dist/auth-provider/authProviderSchemas.js

@@ -38,17 +38,14 @@ exports.UserResponseSchema = validation_1.UserEntitySchema;
 exports.AuthProviderEntitySchema = zod_1.z.object({
     id: zod_1.z.number(),
     identifier: zod_1.z.string(),
-    type: zod_1.z.string().optional(),
-    formIdentifier: zod_1.z.string().optional(),
-    userGroupIdentifier: zod_1.z.string().optional(),
+    type: zod_1.z.string(),
+    formIdentifier: zod_1.z.string().nullable(),
+    userGroupIdentifier: zod_1.z.string(),
     isActive: zod_1.z.boolean(),
-    isCheckCode: zod_1.z.boolean().optional(),
-    version: zod_1.z.number().optional(),
-    localizeInfos: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
-    config: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
-    marker: zod_1.z.string().optional(),
-    name: zod_1.z.string().optional(),
-    position: zod_1.z.number().optional(),
+    isCheckCode: zod_1.z.boolean(),
+    version: zod_1.z.number(),
+    localizeInfos: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    config: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
 });
 /**
  * Auth providers list response schema
@@ -76,10 +73,10 @@ exports.LogoutResponseSchema = zod_1.z.object({
  * @description Schema for validating active sessions response
  */
 exports.ActiveSessionSchema = zod_1.z.object({
-    id: zod_1.z.string(),
-    deviceInfo: zod_1.z.string().optional(),
-    ipAddress: zod_1.z.string().optional(),
-    lastActive: zod_1.z.string().optional(),
-    createdAt: zod_1.z.string(),
+    deviceInfo: zod_1.z.object({
+        os: zod_1.z.string(),
+        browser: zod_1.z.string(),
+        location: zod_1.z.string(),
+    }),
 });
 exports.ActiveSessionsResponseSchema = zod_1.z.array(exports.ActiveSessionSchema);

package/dist/auth-provider/authProvidersInterfaces.d.ts

@@ -359,19 +359,27 @@ interface IAuthProvidersEntity {
  * @interface IAuthProvidersEntityConfig
  * @property {string} accessTokenTtlSec - Access token time to live in seconds. Example: "3600".
  * @property {string} refreshTokenTtlMc - Refresh token time to live in milliseconds. Example: "86400000".
- * @property {string} tokenSecretKey - Token secret key. Example: "secret_key".
  * @property {string} deleteNoneActiveUsersAfterDays - Delete none active users after days. Example: "30".
  * @property {string} systemCodeTlsSec - System code time to live in seconds. Example: "86400".
  * @property {string} systemCodeLength - System code length. Example: "6".
+ * @property {string | null} oauthAuthUrl - OAuth authorization URL. Example: null.
+ * @property {string | null} systemCodeOnlyNumbers - System code only numbers flag. Example: null.
  */
 interface IAuthProvidersEntityConfig {
     accessTokenTtlSec: string;
     refreshTokenTtlMc: string;
-    tokenSecretKey: string;
     deleteNoneActiveUsersAfterDays: string;
     systemCodeTlsSec: string;
     systemCodeLength: string;
+    oauthAuthUrl: string | null;
+    systemCodeOnlyNumbers: string | null;
 }
+/**
+ * Authentication data object.
+ * @interface IAuthData
+ * @property {string} marker - The marker identifying the auth field. Example: "login".
+ * @property {string} value - The value of the auth field. Example: "user@example.com".
+ */
 interface IAuthData {
     marker: string;
     value: string;

package/dist/base/syncModules.js

@@ -70,7 +70,7 @@ class SyncModules {
     _queryParamsToString(query) {
         let result = '';
         for (const key in query) {
-            if (query[key] !== null) {
+            if (query[key] !== null && query[key] !== undefined) {
                 result += `${key}=${query[key]}&`;
             }
         }

package/dist/blocks/blocksApi.d.ts

@@ -47,6 +47,7 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsResponse | IError>} - Returns the total count and an array of product items in object by specified block marker.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
@@ -58,6 +59,7 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsEntity[] | IError>} Return array of BlocksEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */

package/dist/blocks/blocksApi.js

@@ -135,14 +135,16 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsResponse | IError>} - Returns the total count and an array of product items in object by specified block marker.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    async getSimilarProducts(marker, langCode = this.state.lang, offset = 0, limit = 30) {
+    async getSimilarProducts(marker, langCode = this.state.lang, offset = 0, limit = 30, signPrice) {
         const query = {
             langCode,
             offset,
             limit,
+            signPrice,
         };
         const result = await this._fetchGet(`/${marker}/similar-products?` + this._queryParamsToString(query));
         return this._normalizeData(result);
@@ -154,14 +156,16 @@ class BlocksApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {string} [signPrice] - Sign price.
      * @returns {Promise<IProductsEntity[] | IError>} Return array of BlocksEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    async getProductsByBlockMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
+    async getProductsByBlockMarker(marker, langCode = this.state.lang, offset = 0, limit = 30, signPrice) {
         const query = {
             langCode,
             offset,
             limit,
+            signPrice,
         };
         const result = await this._fetchGet(`/${marker}/products?` + this._queryParamsToString(query));
         return this._normalizeData(result.items);

package/dist/discounts/discountsApi.d.ts

@@ -0,0 +1,56 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { ICouponValidationResult, IDiscountsApi, IDiscountsEntity, IDiscountsResponse } from './discountsInterfaces';
+/**
+ * Controllers for working with events
+ * @handle /api/content/events
+ * @class DiscountsApi
+ * @augments AsyncModules
+ * @implements {IDiscountsApi}
+ * @description This class provides methods to interact with events, including subscribing and unsubscribing to product events, and retrieving all subscriptions.
+ */
+export default class DiscountsApi extends AsyncModules implements IDiscountsApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Initializes the Constructor for DiscountsApi class with the provided state module.
+     * @class DiscountsApi
+     * @augments AsyncModules
+     * @implements {DiscountsApi}
+     * @param {StateModule} state - The state module containing the base URL and other configurations.
+     * @description Initializes the DiscountsApi with the provided state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Return all discounts.
+     * @handleName getAllDiscounts
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
+     * @param {string} [type] - Optional parameter to filter discounts by type.
+     * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetches all discounts from the server.
+     */
+    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT' | 'PERSONAL_BONUS'): Promise<IDiscountsResponse | IError>;
+    /**
+     * Get discount by marker
+     * @handleName getDiscountByMarker
+     * @param {string} marker - Textual identifier of the discount storage object. Example: "discount_storage".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetches a discount by its marker.
+     */
+    getDiscountByMarker(marker: string, langCode?: string): Promise<IDiscountsEntity | IError>;
+    /**
+     * Validate discounts coupon
+     * @handleName validateDiscountsCoupon
+     * @param {string} code - The coupon code to validate.
+     * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This function validates a coupon code and returns the result.
+     */
+    validateDiscountsCoupon(code: string): Promise<ICouponValidationResult | IError>;
+}

package/dist/discounts/discountsApi.js

@@ -0,0 +1,82 @@
+"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"));
+/**
+ * Controllers for working with events
+ * @handle /api/content/events
+ * @class DiscountsApi
+ * @augments AsyncModules
+ * @implements {IDiscountsApi}
+ * @description This class provides methods to interact with events, including subscribing and unsubscribing to product events, and retrieving all subscriptions.
+ */
+class DiscountsApi extends asyncModules_1.default {
+    /**
+     * Initializes the Constructor for DiscountsApi class with the provided state module.
+     * @class DiscountsApi
+     * @augments AsyncModules
+     * @implements {DiscountsApi}
+     * @param {StateModule} state - The state module containing the base URL and other configurations.
+     * @description Initializes the DiscountsApi with the provided state module.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/discounts';
+    }
+    /**
+     * Return all discounts.
+     * @handleName getAllDiscounts
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
+     * @param {string} [type] - Optional parameter to filter discounts by type.
+     * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetches all discounts from the server.
+     */
+    async getAllDiscounts(langCode = this.state.lang, offset = 0, limit = 30, type) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+            type,
+        };
+        const data = await this._fetchGet(`?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Get discount by marker
+     * @handleName getDiscountByMarker
+     * @param {string} marker - Textual identifier of the discount storage object. Example: "discount_storage".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetches a discount by its marker.
+     */
+    async getDiscountByMarker(marker, langCode = this.state.lang) {
+        const query = {
+            marker: '',
+            langCode,
+        };
+        const data = await this._fetchGet(`/marker/${marker}?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+    /**
+     * Validate discounts coupon
+     * @handleName validateDiscountsCoupon
+     * @param {string} code - The coupon code to validate.
+     * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This function validates a coupon code and returns the result.
+     */
+    async validateDiscountsCoupon(code) {
+        const query = {
+            code,
+        };
+        const data = await this._fetchGet(`/coupons/validate?` + this._queryParamsToString(query));
+        return this._normalizeData(data);
+    }
+}
+exports.default = DiscountsApi;

package/dist/discounts/discountsInterfaces.d.ts

@@ -0,0 +1,145 @@
+import type { IError } from 'base/utils';
+/**
+ * Interface for the Discounts API module.
+ * @interface IDiscountsApi
+ */
+interface IDiscountsApi {
+    /**
+     * Return all discounts.
+     * @handleName getAllSubscriptions
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
+     * @param {string} [type] - Optional parameter to filter discounts by type.
+     * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetches all discounts from the server.
+     */
+    getAllDiscounts(langCode?: string, offset?: number, limit?: number, type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT' | 'PERSONAL_BONUS'): Promise<IDiscountsResponse | IError>;
+    /**
+     * Get discount by marker
+     * @handleName getDiscountByMarker
+     * @param {string} marker - Textual identifier of the discount storage object. Example: "discount_storage".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetches a discount by its marker.
+     */
+    getDiscountByMarker(marker: string, langCode: string): Promise<IDiscountsEntity | IError>;
+    /**
+     * Validate discounts coupon
+     * @handleName validateDiscountsCoupon
+     * @param {string} code - The coupon code to validate.
+     * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This function validates a coupon code and returns the result.
+     */
+    validateDiscountsCoupon(code: string): Promise<ICouponValidationResult | IError>;
+}
+/**
+ * Query parameters for fetching discounts.
+ * @interface IDiscountsQuery
+ * @property {'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT' | 'PERSONAL_BONUS'} [type] - Filter discounts by type.
+ * @property {string} langCode - The language code for localization. Example: "en_US".
+ * @property {number} [offset] - Offset for pagination. Default: 0.
+ * @property {number} [limit] - Limit for pagination. Default: 30.
+ */
+interface IDiscountsQuery {
+    type?: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT' | 'PERSONAL_BONUS';
+    langCode: string;
+    offset?: number;
+    limit?: number;
+}
+/**
+ * Represents a discount condition.
+ * @interface IDiscountCondition
+ * @property {string} type - The type of discount condition.
+ * @property {string} [value] - The value associated with the discount condition.
+ */
+interface IDiscountCondition {
+    type: 'PRODUCT' | 'CATEGORY' | 'ATTRIBUTE' | 'PRODUCT_IN_CART' | 'CATEGORY_IN_CART' | 'MIN_CART_AMOUNT' | 'USER_LTV' | 'USER_ATTRIBUTE';
+    value: string;
+}
+/**
+ * Represents a discount entity.
+ * @interface IDiscountsEntity
+ * @property {number} id - The unique identifier of the discount.
+ * @property {number} [attributeSetId] - The identifier of the discount.
+ * @property {object} [localizeInfos] - The name of the discount.
+ * @property {number} [version] - The version of the discount.
+ * @property {string} [identifier] - The identifier of the discount.
+ * @property {string} [type] - The type of the discount.
+ * @property {string} [startDate] - The start date of the discount.
+ * @property {string} [endDate] - The end date of the discount.
+ * @property {Record<string, unknown>} [discountValue] - The value of the discount.
+ * @property {string} [conditionLogic] - The logic of the discount. Possible values are "AND" | "OR".
+ * @property {IDiscountCondition[]} [conditions] - The conditions of the discount.
+ * @property {object} [exclusions] - The exclusions of the discount.
+ * @property {object} [gifts] - The gifts of the discount.
+ * @property {boolean} [giftsReplaceCartItems] - Whether the gifts replace cart items.
+ * @property {object} [userGroups] - The user groups of the discount.
+ * @property {object} [userExclusions] - The user exclusions of the discount.
+ * @property {object} [attributeValues] - The attribute values of the discount.
+ * @property {string} [attributeSetIdentifier] - The identifier of the attribute set.
+ */
+interface IDiscountsEntity {
+    id: number;
+    attributeSetId?: number;
+    localizeInfos?: object;
+    version?: number;
+    identifier?: string;
+    type: 'DISCOUNT' | 'BONUS' | 'PERSONAL_DISCOUNT' | 'PERSONAL_BONUS';
+    startDate?: string;
+    endDate?: string;
+    discountValue?: Record<string, unknown>;
+    conditionLogic?: 'AND' | 'OR';
+    conditions?: IDiscountCondition[];
+    exclusions?: object;
+    gifts?: object;
+    giftsReplaceCartItems?: boolean;
+    userGroups?: object;
+    userExclusions?: object;
+    attributeValues?: object;
+    attributeSetIdentifier?: string;
+}
+/**
+ * Paginated response for discounts list.
+ * @interface IDiscountsResponse
+ * @property {IDiscountsEntity[]} items - Array of discount entities.
+ * @property {number} total - Total number of discounts.
+ */
+interface IDiscountsResponse {
+    items: IDiscountsEntity[];
+    total: number;
+}
+/**
+ * Request body for coupon validation.
+ * @interface IDiscountsValidateCoupon
+ * @property {string} code - The coupon code to validate.
+ */
+interface IDiscountsValidateCoupon {
+    code: string;
+}
+/**
+ * Result of coupon validation.
+ * @interface ICouponValidationResult
+ * @property {boolean} valid - Whether the coupon is valid.
+ * @property {unknown} [coupon] - Coupon data if the coupon is valid.
+ * @property {string} [error] - Error message if the coupon is invalid.
+ */
+interface ICouponValidationResult {
+    valid: boolean;
+    coupon?: unknown;
+    error?: string;
+}
+/**
+ * Query parameters for fetching a discount by marker.
+ * @interface IDiscountByMarkerQuery
+ * @property {string} langCode - The language code for localization. Example: "en_US".
+ * @property {string} marker - Textual identifier of the discount. Example: "example_discount".
+ */
+interface IDiscountByMarkerQuery {
+    langCode: string;
+    marker: string;
+}
+export type { ICouponValidationResult, IDiscountByMarkerQuery, IDiscountCondition, IDiscountsApi, IDiscountsEntity, IDiscountsQuery, IDiscountsResponse, IDiscountsValidateCoupon, };

package/dist/discounts/discountsInterfaces.js

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