oneentry 1.0.141 → 1.0.142

package/dist/orders/ordersApi.js

@@ -1,203 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const asyncModules_1 = __importDefault(require("../base/asyncModules"));
-const ordersSchemas_1 = require("./ordersSchemas");
-/**
- * Controllers for working with orders.
- * @handle /api/content/orders-storage
- * @module OrdersApi
- * @description This module provides methods for working with orders, including retrieving, creating, and updating orders in the order storage.
- */
-class OrdersApi extends asyncModules_1.default {
-    /**
-     * Constructs an instance of the OrdersApi class.
-     * @param {StateModule} state - The state module containing the necessary information for making API calls.
-     * @description Constructor initializes the OrdersApi with a given state.
-     */
-    constructor(state) {
-        super(state);
-        this._url = state.url + '/api/content/orders-storage';
-    }
-    /**
-     * Getting all the order storage objects.
-     * @handleName getAllOrdersStorage
-     * @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.
-     * @returns {Promise<IOrdersEntity[] | IError>} Returns an array of order storage objects.
-     * @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 getAllOrdersStorage(langCode = this.state.lang, offset = 0, limit = 30) {
-        const result = await this._fetchGet(`?langCode=${langCode}&limit=${limit}&offset=${offset}`);
-        return this._normalizeData(result);
-    }
-    /**
-     * Getting all orders from the orders storage object created by the user.
-     * @handleName getAllOrdersByMarker
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Offset parameter. Default: 0.
-     * @param {number} [limit] - Limit parameter. Default: 30.
-     * @returns {Promise<IOrdersByMarkerEntity | IError>} Returns an object with the orders.
-     * @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 getAllOrdersByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
-        const result = await this._fetchGet(`/marker/${marker}/orders?langCode=${langCode}&limit=${limit}&offset=${offset}`);
-        // Validate response if validation is enabled
-        const validated = this._validateResponse(result, ordersSchemas_1.OrdersResponseSchema);
-        return this._normalizeData(validated);
-    }
-    /**
-     * Retrieve one order storage object by marker.
-     * @handleName getOrdersStorageByMarker
-     * @param {string} marker - Marker of the order object. Example: "order_storage_1".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IOrdersEntity | IError>} Return object of order information.
-     * @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 getOrdersStorageByMarker(marker, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
-        return this._normalizeData(result);
-    }
-    /**
-     * Getting a single order from the order storage object created by the user.
-     * @handleName getOrderByMarkerAndId
-     * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
-     * @param {number} id - ID of the order object. Example: 12345.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
-     * @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 getOrderByMarkerAndId(marker, id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${marker}/orders/${id}?langCode=${langCode}`);
-        // Validate response if validation is enabled
-        const validated = this._validateResponse(result, ordersSchemas_1.OrderEntitySchema);
-        return this._normalizeData(validated);
-    }
-    /**
-     * Preview order calculation with discounts and coupons (without saving).
-     * @handleName previewOrder
-     * @param {ICreateOrderPreview} body - Order preview body.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IOrderPreviewResponse | IError>} Returns an object with the order preview.
-     * @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 previewOrder(body, langCode = this.state.lang) {
-        const result = await this._fetchPost(`/orders/preview?langCode=${langCode}`, body);
-        return this._normalizeData(result);
-    }
-    /**
-     * Creation of an order in the order storage.
-     * @handleName createOrder
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {IOrderData} body - Object for creating an order.
-     * @example
-        {
-          "formIdentifier": "bar-orders-form",
-          "paymentAccountIdentifier": "usd-payment",
-          "formData": {
-            "marker": "name_1",
-            "value": "Name",
-            "type": "string"
-          },
-          "products": [
-            {
-            "productId": 1,
-            "quantity": 2
-            }
-          ]
-        }
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the created order.
-     * @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 createOrder(marker, body, langCode = this.state.lang) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const formData = {};
-        formData[langCode] = Array.isArray(body.formData)
-            ? body.formData
-            : [body.formData];
-        body.formData = formData;
-        const result = await this._fetchPost(`/marker/${marker}/orders`, body);
-        // Validate response if validation is enabled
-        const validated = this._validateResponse(result, ordersSchemas_1.CreateOrderResponseSchema);
-        return this._normalizeData(validated);
-    }
-    /**
-     * Changing an order in the orders storage
-     * @handleName updateOrderByMarkerAndId
-     * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
-     * @param {number} id - ID of the order object. Example: 12345.
-     * @param {IOrderData} body - Object for updating an order.
-     * @example
-        {
-          "formIdentifier": "bar-orders-form",
-          "paymentAccountIdentifier": "usd-payment",
-          "formData": {
-            "marker": "name_1",
-            "value": "Name",
-            "type": "string"
-          },
-          "products": [
-            {
-            "productId": 1,
-            "quantity": 2
-            }
-          ],
-          "currency": "USD"
-        }
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the updated order.
-     * @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 updateOrderByMarkerAndId(marker, id, body, langCode = this.state.lang) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const formData = {};
-        formData[langCode] = Array.isArray(body.formData)
-            ? body.formData
-            : [body.formData];
-        body.formData = formData;
-        const result = await this._fetchPut(`/marker/${marker}/orders/${id}?langCode=${langCode}`, body);
-        // Validate response if validation is enabled
-        const validated = this._validateResponse(result, ordersSchemas_1.UpdateOrderResponseSchema);
-        return this._normalizeData(validated);
-    }
-    /**
-     * Get all orders statuses by Storage marker
-     * @handleName getAllStatusesByStorageMarker
-     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Offset parameter. Default: 0.
-     * @param {number} [limit] - Limit parameter. Default: 30.
-     * @returns {Promise<IOrderStatus[] | IError>} Returns an object with the orders statuses.
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @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 getAllStatusesByStorageMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
-        const query = {
-            langCode,
-            offset,
-            limit,
-        };
-        const data = await this._fetchGet(`/marker/${marker}/order-statuses?` + this._queryParamsToString(query));
-        return this._normalizeData(data);
-    }
-}
-exports.default = OrdersApi;