oneentry 1.0.142 → 1.0.143

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 });

package/dist/events/eventsApi.d.ts

@@ -0,0 +1,60 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IEvents, ISubscriptions } from './eventsInterfaces';
+/**
+ * Controllers for working with events
+ * @handle /api/content/events
+ * @class EventsApi
+ * @augments AsyncModules
+ * @implements {IEvents}
+ * @description This class provides methods to interact with events, including subscribing and unsubscribing to product events, and retrieving all subscriptions.
+ */
+export default class EventsApi extends AsyncModules implements IEvents {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Initializes the EventsApi with the provided state module.
+     * @class EventsApi
+     * @augments AsyncModules
+     * @implements {IEvents}
+     * @param {StateModule} state - The state module containing the base URL and other configurations.
+     * @description Initializes the EventsApi with the provided state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Return all subscriptions to product.
+     * @handleName getAllSubscriptions
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {Promise<ISubscriptions | IError>} Returns an object containing all subscriptions or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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}.
+     */
+    getAllSubscriptions(offset?: number, limit?: number): Promise<ISubscriptions | IError>;
+    /**
+     * Subscribing to an event on a product.
+     * @handleName subscribeByMarker
+     * @param {string} marker - Event marker. Example: "product_price_change".
+     * @param {number} productId - Product id. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".=
+     * @returns {Promise<boolean | IError>} Returns true if subscription was successful, or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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}.
+     */
+    subscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
+    /**
+     * Unsubscribing to an event on a product.
+     * @handleName unsubscribeByMarker
+     * @param {string} marker - The marker of the event to unsubscribe from. Example: "product_price_change".
+     * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<any | IError>} - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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}.
+     */
+    unsubscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
+}

package/dist/events/eventsApi.js

@@ -0,0 +1,97 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable jsdoc/reject-any-type */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+/**
+ * Controllers for working with events
+ * @handle /api/content/events
+ * @class EventsApi
+ * @augments AsyncModules
+ * @implements {IEvents}
+ * @description This class provides methods to interact with events, including subscribing and unsubscribing to product events, and retrieving all subscriptions.
+ */
+class EventsApi extends asyncModules_1.default {
+    /**
+     * Initializes the EventsApi with the provided state module.
+     * @class EventsApi
+     * @augments AsyncModules
+     * @implements {IEvents}
+     * @param {StateModule} state - The state module containing the base URL and other configurations.
+     * @description Initializes the EventsApi with the provided state module.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/events';
+    }
+    /**
+     * Return all subscriptions to product.
+     * @handleName getAllSubscriptions
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {Promise<ISubscriptions | IError>} Returns an object containing all subscriptions or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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 getAllSubscriptions(offset = 0, limit = 30) {
+        const query = {
+            offset,
+            limit,
+        };
+        const result = await this._fetchGet(`/subscriptions?` + this._queryParamsToString(query));
+        return result;
+    }
+    /**
+     * Subscribing to an event on a product.
+     * @handleName subscribeByMarker
+     * @param {string} marker - Event marker. Example: "product_price_change".
+     * @param {number} productId - Product id. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".=
+     * @returns {Promise<boolean | IError>} Returns true if subscription was successful, or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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 subscribeByMarker(marker, productId, langCode = this.state.lang) {
+        const body = {
+            locale: langCode,
+            productId,
+        };
+        try {
+            await this._fetchPost(`/subscribe/marker/${marker}`, body);
+            return true;
+        }
+        catch (e) {
+            return e;
+        }
+    }
+    /**
+     * Unsubscribing to an event on a product.
+     * @handleName unsubscribeByMarker
+     * @param {string} marker - The marker of the event to unsubscribe from. Example: "product_price_change".
+     * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<any | IError>} - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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 unsubscribeByMarker(marker, productId, langCode = this.state.lang) {
+        const body = {
+            productId: productId,
+            locale: langCode,
+        };
+        try {
+            await this._fetchDelete(`/unsubscribe/marker/${marker}`, body);
+            return true;
+        }
+        catch (e) {
+            return e;
+        }
+    }
+}
+exports.default = EventsApi;

package/dist/events/eventsInterfaces.d.ts

@@ -0,0 +1,87 @@
+import type { IError } from '../base/utils';
+/**
+ * Interface for managing event subscriptions related to products.
+ * @interface IEvents
+ * @description This interface defines methods for managing event subscriptions related to products.
+ */
+interface IEvents {
+    /**
+     * Retrieves all subscriptions to products.
+     * @handleName getAllSubscriptions
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {Promise<ISubscriptions | IError>} A promise that resolves to a subscriptions object or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves all subscriptions to products.
+     */
+    getAllSubscriptions(offset?: number, limit?: number): Promise<ISubscriptions | IError>;
+    /**
+     * Subscribes to an event on a product by its marker.
+     * @handleName subscribeByMarker
+     * @param {string} marker - The marker identifying the event. Example: "product_price_change".
+     * @param {number} productId - The ID of the product to subscribe to. Example: 12345.
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @returns {Promise<boolean | IError>} A promise that resolves to any type or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method subscribes to an event on a product by its marker.
+     */
+    subscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
+    /**
+     * Unsubscribes from an event on a product by its marker.
+     * @handleName unsubscribeByMarker
+     * @param {string} marker - The marker identifying the event. Example: "product_price_change".
+     * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @returns {Promise<boolean | IError>} A promise that resolves to any type or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method unsubscribes from an event on a product by its marker.
+     */
+    unsubscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
+}
+/**
+ * Represents a response from the events API containing a total count and an array of subscription items.
+ * @interface ISubscriptions
+ * @property {number} total - Total number of found records. Example: 100.
+ * @property {ISubscriptionItem[]} items - Array of subscription items, each containing an event marker and a product ID.
+ * @example
+ [
+   {
+     eventMarker: 'product_price_change',
+     productId: 12345
+   },
+   {
+     eventMarker: 'product_stock_update',
+     productId: 67890
+   }
+ ]
+ * @property { string } items.eventMarker - Event marker.
+ * @property { number } items.productId - Product ID.
+ * @description Represents a response from the events API containing a total count and an array of subscription items.
+ */
+interface ISubscriptions {
+    total: number;
+    items: Array<ISubscriptionItem>;
+}
+/**
+ * Represents item from the events API.
+ * @interface ISubscriptionItem
+ * @property { string } eventMarker -Event marker.
+ * @property { number } productId - Product ID.
+ * @description Represents item from the events API.
+ */
+interface ISubscriptionItem {
+    eventMarker: string;
+    productId: number;
+}
+/**
+ * Interface for the body of the subscribe methods.
+ * @interface ISubscribeBody
+ * @property {string} locale - Locale of the user. Example: "en_US".
+ * @property {number} productId - Product ID. Example: 12345.
+ * @description Represents a body for the subscribe methods, containing the locale and product ID.
+ */
+interface ISubscribeBody {
+    locale: string;
+    productId: number;
+}
+export type { IEvents, ISubscribeBody, ISubscriptions };

package/dist/events/eventsInterfaces.js

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

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

@@ -0,0 +1,88 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IFileUploading, IUploadingQuery, IUploadingReturn } from './fileUploadingInterfaces';
+/**
+ * Controllers for working with file uploading
+ * @handle /api/content/files
+ * @class FileUploadingApi
+ * @augments AsyncModules
+ * @implements {IFileUploading}
+ * @description This class provides methods to upload and delete files in a cloud file storage, as well as retrieve files by parameters.
+ */
+export default class FileUploadingApi extends AsyncModules implements IFileUploading {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructs a new instance of the FileUploadingApi class.
+     */
+    constructor(state: StateModule);
+    /** FileUploadingApi class */
+    private _defaultQuery;
+    /**
+     * Upload file function.
+     * @handleName upload
+     * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
+        {
+          "type": "page",
+          "entity": "editor",
+          "id": 3787,
+          "width": 0,
+          "height": 0,
+          "compress": true,
+          "template": 1
+        }
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
+     * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
+     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
+     * @param {string | number} [fileQuery.template] - preview template identifier. Example: 1.
+     * @returns {Promise<IUploadingReturn[] | IError>} Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
+    /**
+     * Deletes a file from the cloud file storage.
+     * @handleName delete
+     * @param {string} filename - File name. Example: "file.png".
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @example
+        {
+          "type": "page",
+          "entity": "editor",
+          "id": 3787,
+          "template": 1
+        }
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
+     * @returns {Promise<boolean | IError>} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    delete(filename: string, fileQuery?: IUploadingQuery): Promise<boolean | IError>;
+    /**
+     * Create a File object from a URL.
+     * @param {string} url - The URL to fetch the file from.
+     * @param {string} filename - The name to give the created file.
+     * @param {string} [mimeType] - Optional MIME type for the file.
+     * @returns {Promise<File>} A promise that resolves to a File object.
+     */
+    createFileFromUrl(url: string, filename: string, mimeType?: string): Promise<File>;
+    /**
+     * Get file by parameters.
+     * @handleName getFile
+     * @param {number} id - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} entity - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {string} filename - Filename. Example: "file.png".
+     * @param {string} [template] - Preview template identifier. Example: 1.
+     * @returns {Promise<Response | IError>} Returns a promise that resolves to a Response object containing the file data or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getFile(id: number, type: string, entity: string, filename: string, template?: string): Promise<Response | IError>;
+}