@snabcentr/client-core 2.65.2 → 2.66.0

package/order/{dto → classes}/index.d.ts

@@ -1,8 +1,10 @@
 export * from './sc-delivery-cost';
-export * from './sc-i-new-order';
-export * from './sc-i-new-order-from-draft';
-export * from './sc-order';
+export * from './sc-order-base';
+export * from './sc-order-draft';
+export * from './sc-order-draft-short';
 export * from './sc-order-delivery';
 export * from './sc-order-history';
+export * from './sc-order-item';
 export * from './sc-order-payment';
 export * from './sc-order-short';
+export * from './sc-order';

package/order/{dto → classes}/sc-delivery-cost.d.ts

@@ -1,6 +1,6 @@
 import { ScIDeliveryCostDTO } from '../internal';
 /**
- * Модель данных о бесплатной доставке.
+ * Данные о стоимости доставки.
  */
 export declare class ScDeliveryCost {
     /**
@@ -27,7 +27,7 @@ export declare class ScDeliveryCost {
     /**
      * Инициализирует экземпляр класса {@link ScDeliveryCost}.
      *
-     * @param deliveryCost DTO данных о бесплатной доставке.
+     * @param deliveryCost Данные о стоимости доставки (DTO).
      * @param deliveryDate Дата доставки.
      */
     constructor(deliveryCost: ScIDeliveryCostDTO, deliveryDate: string);

package/order/classes/sc-order-base.d.ts

@@ -0,0 +1,32 @@
+import { ScIOrderBase } from '../internal/sc-i-order-base';
+/**
+ * Базовые данные о заказе.
+ */
+export declare class ScOrderBase implements ScIOrderBase {
+    /**
+     * @inheritDoc
+     */
+    id: number;
+    /**
+     * @inheritDoc
+     */
+    createdAt: string;
+    /**
+     * @inheritDoc
+     */
+    sum: number;
+    /**
+     * Инициализирует экземпляр класса {@link ScOrderBase}.
+     *
+     * @param data Данные для первоначальной инициализации.
+     */
+    constructor(data: ScIOrderBase);
+    /**
+     * @inheritDoc
+     */
+    getSumStr(): string;
+    /**
+     * @inheritDoc
+     */
+    getSumMessage(): string;
+}

package/order/classes/sc-order-draft-short.d.ts

@@ -0,0 +1,22 @@
+import { ScOrderDraftType } from '../enums/sc-order-draft-type';
+import { ScIOrderDraftShort } from '../internal';
+import { ScOrderBase } from './sc-order-base';
+/**
+ * Данные о кратком коммерческом предложении/черновике заказа.
+ */
+export declare class ScOrderDraftShort extends ScOrderBase implements ScIOrderDraftShort {
+    /**
+     * @inheritDoc
+     */
+    name?: string;
+    /**
+     * @inheritDoc
+     */
+    type: ScOrderDraftType;
+    /**
+     * Инициализирует экземпляр класса {@link ScOrderDraftShort}.
+     *
+     * @param data Данные для первоначальной инициализации.
+     */
+    constructor(data: ScIOrderDraftShort);
+}

package/order/classes/sc-order-draft.d.ts

@@ -0,0 +1,63 @@
+import { ScOrderDraftType } from '../enums/sc-order-draft-type';
+import { ScIOrderDraft } from '../internal';
+import { ScOrderDraftShort } from './sc-order-draft-short';
+import { ScOrderItem } from './sc-order-item';
+/**
+ * Данные о коммерческом предложении/черновике заказа.
+ */
+export declare class ScOrderDraft implements ScIOrderDraft {
+    /**
+     * @inheritDoc
+     */
+    id: number;
+    /**
+     * @inheritDoc
+     */
+    name?: string;
+    /**
+     * @inheritDoc
+     */
+    type: ScOrderDraftType;
+    /**
+     * @inheritDoc
+     */
+    createdAt: string;
+    /**
+     * @inheritDoc
+     */
+    sum: number;
+    /**
+     * @inheritDoc
+     */
+    products: ScOrderItem[];
+    /**
+     * Дата последнего обновления данных.
+     */
+    private lastUpdateDate;
+    /**
+     * Инициализирует экземпляр класса {@link ScOrderDraft}.
+     *
+     * @param data Данные для первоначальной инициализации.
+     */
+    constructor(data: ScIOrderDraft);
+    /**
+     * @inheritDoc
+     */
+    getSumStr(): string;
+    /**
+     * @inheritDoc
+     */
+    getSumMessage(): string;
+    /**
+     * @inheritDoc
+     */
+    cachedDataIsActual(lifeTime: number): boolean;
+    /**
+     * @inheritDoc
+     */
+    updateData(offer: ScOrderDraft): void;
+    /**
+     * @inheritDoc
+     */
+    updateDataFromShortOffer(offer: ScOrderDraftShort): void;
+}

package/order/{dto → classes}/sc-order-history.d.ts

@@ -1,5 +1,5 @@
 /**
- * Модель данных истории изменения статусов заказа.
+ * Данные об истории изменения статусов заказа.
  */
 export interface ScIOrderHistory {
     /**

package/order/classes/sc-order-item.d.ts

@@ -0,0 +1,98 @@
+import { ScProduct } from '../../catalog/dto/sc-product';
+import { ScIConfiguratorSearchProductBase } from '../../configurator/dto/sc-i-configurator-search-product-base';
+import { ScIOrderItem } from '../internal/sc-i-order-item';
+/**
+ * Данные о единичной позиции товара/услуги в заказе (корзине / черновике).
+ */
+export declare class ScOrderItem {
+    /**
+     * @inheritDoc
+     */
+    id: string;
+    /**
+     * @inheritDoc
+     */
+    product: ScProduct;
+    /**
+     * @inheritDoc
+     */
+    quantity: number;
+    /**
+     * @inheritDoc
+     */
+    cost: number;
+    /**
+     * @inheritDoc
+     */
+    costOne: number;
+    /**
+     * @inheritDoc
+     */
+    costOneRub: number;
+    /**
+     * @inheritDoc
+     */
+    costRub: number;
+    /**
+     * @inheritDoc
+     */
+    marker?: string;
+    /**
+     * @inheritDoc
+     */
+    height?: number;
+    /**
+     * @inheritDoc
+     */
+    length?: number;
+    /**
+     * @inheritDoc
+     */
+    width?: number;
+    /**
+     * @inheritDoc
+     */
+    logicGroupId?: string;
+    /**
+     * @inheritDoc
+     */
+    salesDirection?: number;
+    /**
+     * @inheritDoc
+     */
+    specificationImgUrl?: string;
+    /**
+     * @inheritDoc
+     */
+    configurator?: string;
+    /**
+     * @inheritDoc
+     */
+    configuratorParams?: ScIConfiguratorSearchProductBase;
+    /**
+     * Инициализирует экземпляр класса {@link ScOrderItem}.
+     *
+     * @param data Данные для первоначальной инициализации.
+     */
+    constructor(data: ScIOrderItem);
+    /**
+     * @inheritDoc
+     */
+    getCostPerItem(): string;
+    /**
+     * @inheritDoc
+     */
+    getCostInCurrencyDescPerItem(): string;
+    /**
+     * @inheritDoc
+     */
+    getCostInRubDescPerItem(): string;
+    /**
+     * @inheritDoc
+     */
+    getCostRubStr(): string;
+    /**
+     * @inheritDoc
+     */
+    getCostMessage(): string;
+}

package/order/{dto → classes}/sc-order-payment.d.ts

@@ -1,7 +1,7 @@
 import { ScPaymentStatus } from '../../references';
 import { ScPaymentType } from '../enums';
 /**
- * Модель данных информации об оплате заказа.
+ * Данные об оплате заказа.
  */
 export interface ScIOrderPayment {
     /**

package/order/classes/sc-order-short.d.ts

@@ -0,0 +1,44 @@
+import { ScOrderStateStatus } from '../../references';
+import { ScIOrderShort } from '../internal';
+import { ScOrderBase } from './sc-order-base';
+import { ScIOrderDelivery } from './sc-order-delivery';
+import { ScIOrderPayment } from './sc-order-payment';
+/**
+ * Данные о кратком заказе.
+ */
+export declare class ScOrderShort extends ScOrderBase implements ScIOrderShort {
+    /**
+     * @inheritDoc
+     */
+    status: ScOrderStateStatus;
+    /**
+     * @inheritDoc
+     */
+    direction: number;
+    /**
+     * @inheritDoc
+     */
+    payment: ScIOrderPayment;
+    /**
+     * @inheritDoc
+     */
+    delivery: ScIOrderDelivery;
+    /**
+     * @inheritDoc
+     */
+    numberDoc?: number;
+    /**
+     * @inheritDoc
+     */
+    barcode?: number;
+    /**
+     * Инициализирует экземпляр класса {@link ScOrderShort}.
+     *
+     * @param data Данные для первоначальной инициализации.
+     */
+    constructor(data: ScIOrderShort);
+    /**
+     * @inheritDoc
+     */
+    updateData(order: ScOrderShort): void;
+}

package/order/classes/sc-order.d.ts

@@ -0,0 +1,102 @@
+import { ScContragent } from '../../contragent/dto/sc-contragent';
+import { ScDeliveryType, ScPaymentType } from '../enums';
+import { ScIOrder } from '../internal';
+import { ScIOrderHistory } from './sc-order-history';
+import { ScOrderItem } from './sc-order-item';
+import { ScOrderShort } from './sc-order-short';
+/**
+ * Данные о заказе.
+ */
+export declare class ScOrder extends ScOrderShort implements ScIOrder {
+    /**
+     * @inheritDoc
+     */
+    products: ScOrderItem[];
+    /**
+     * @inheritDoc
+     */
+    history?: ScIOrderHistory[];
+    /**
+     * @inheritDoc
+     */
+    invoices?: string[];
+    /**
+     * @inheritDoc
+     */
+    comment?: string;
+    /**
+     * @inheritDoc
+     */
+    image?: string;
+    /**
+     * @inheritDoc
+     */
+    contragent?: ScContragent;
+    /**
+     * @inheritDoc
+     */
+    attachedUser?: {
+        /**
+         * Тип пользователя.
+         */
+        type: string;
+        /**
+         * ФИО пользователя.
+         */
+        name: string;
+        /**
+         * Номер телефона. В формате "79203436527" или "+79203436527".
+         */
+        phone: string;
+        /**
+         * Адрес электронной почты.
+         */
+        email: string;
+    };
+    /**
+     * @inheritDoc
+     */
+    lastUpdateDate: Date;
+    /**
+     * Инициализирует экземпляр класса {@link ScOrder}.
+     *
+     * @param data Данные для первоначальной инициализации.
+     */
+    constructor(data: ScIOrder);
+    /**
+     * @inheritDoc
+     */
+    get paymentType(): ScPaymentType;
+    /**
+     * @inheritDoc
+     */
+    get deliveryType(): ScDeliveryType;
+    /**
+     * @inheritDoc
+     */
+    get isPayable(): boolean;
+    /**
+     * @inheritDoc
+     */
+    get isPayableSoon(): boolean;
+    /**
+     * @inheritDoc
+     */
+    get isCompleted(): boolean;
+    /**
+     * @inheritDoc
+     */
+    get isNew(): boolean;
+    /**
+     * @inheritDoc
+     */
+    cachedDataIsActual(orderLifeTime: number): boolean;
+    /**
+     * @inheritDoc
+     */
+    updateData(order: ScOrder): void;
+    /**
+     * @inheritDoc
+     */
+    updateDataFromShortOrder(order: ScOrderShort): void;
+}

package/order/enums/index.d.ts

@@ -1,2 +1,3 @@
 export * from './sc-delivery-type';
+export * from './sc-order-draft-type';
 export * from './sc-payment-type';

package/order/enums/sc-order-draft-type.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Перечисление типов коммерческих предложений/черновиков заказа.
+ */
+export declare enum ScOrderDraftType {
+    /**
+     * Коммерческое предложение.
+     */
+    offer = "offer",
+    /**
+     * Заказ-черновик.
+     */
+    draft = "draft"
+}

package/order/index.d.ts

@@ -1,3 +1,5 @@
-export * from './dto';
+export * from './classes';
 export * from './enums';
-export * from './services/sc-orders.service';
+export * from './internal';
+export * from './services';
+export * from './tokens';

package/order/internal/index.d.ts

@@ -1,3 +1,14 @@
+export * from './sc-i-new-order-draft-request';
 export * from './sc-i-delivery-cost-dto';
-export * from './sc-i-order-dto';
-export * from './sc-i-order-short-dto';
+export * from './sc-i-new-order';
+export * from './sc-i-new-order-item-base';
+export * from './sc-i-new-order-item-measured';
+export * from './sc-i-order-base';
+export * from './sc-i-order-draft';
+export * from './sc-i-order-draft-list-params';
+export * from './sc-i-order-draft-short';
+export * from './sc-i-order';
+export * from './sc-i-order-item';
+export * from './sc-i-order-loader';
+export * from './sc-i-order-short';
+export * from './sc-i-update-order-order-request';

package/order/internal/sc-i-delivery-cost-dto.d.ts

@@ -1,5 +1,5 @@
 /**
- * DTO модель данных о бесплатной доставке.
+ * Данные о стоимости доставки (DTO).
  *
  * @internal
  */

package/order/internal/sc-i-new-order-draft-request.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Данные о запросе на создание коммерческого предложения/черновика заказа.
+ */
+export interface ScINewOrderDraftRequest {
+    /**
+     * Название коммерческого предложения/черновика (опционально).
+     */
+    name?: string;
+    /**
+     * Список идентификаторов элементов корзины, которые попадут в КП/черновик.
+     */
+    items?: string[];
+}

package/{cart/dto/sc-i-new-cart-item-base.d.ts → order/internal/sc-i-new-order-item-base.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Модель данных товара, который необходимо добавить в корзину.
+ * Данные о товаре для добавления в корзину.
  */
-export interface ScINewCartItemBase {
+export interface ScINewOrderItemBase {
     /**
      * Идентификатор записи товара/услуги.
      */

package/order/internal/sc-i-new-order-item-measured.d.ts

@@ -0,0 +1,10 @@
+import { ScINewOrderItemBase } from './sc-i-new-order-item-base';
+/**
+ * Данные о товаре «в рез» для добавления в корзину.
+ */
+export interface ScINewCartItemMeasured extends ScINewOrderItemBase {
+    /**
+     * Длина товара.
+     */
+    length: number;
+}

package/order/{dto → internal}/sc-i-new-order.d.ts

@@ -2,7 +2,7 @@ import { ScUploadedFile } from '../../contacts/dto/sc-uploaded-file';
 import { ScUTM } from '../../utm/interfaces';
 import { ScDeliveryType, ScPaymentType } from '../enums';
 /**
- * Модель данных нового заказа.
+ * Данные о новом заказе.
  */
 export interface ScINewOrder {
     /**
@@ -41,10 +41,6 @@ export interface ScINewOrder {
      * Список идентификаторов элементов корзины, которые попадут в заказ.
      */
     items?: Array<number | string>;
-    /**
-     * Признак того, что это черновик заказа.
-     */
-    isDraft?: boolean;
     /**
      * Данные о UTM-метке.
      */

package/order/internal/sc-i-order-base.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Базовые данные о заказе.
+ */
+export interface ScIOrderBase {
+    /**
+     * Идентификатор записи заказа.
+     */
+    id: number;
+    /**
+     * Дата и время создания заказа.
+     */
+    createdAt: string;
+    /**
+     * Сумма заказа.
+     */
+    sum: number;
+    /**
+     * Возвращает сумму заказа в виде строки. Если стоимость отсутствует, то вернёт '-'.
+     */
+    getSumStr(): string;
+    /**
+     * Возвращает сообщение о необходимости уточнить сумму заказа или пустую строку.
+     */
+    getSumMessage(): string;
+}

package/order/internal/sc-i-order-draft-list-params.d.ts

@@ -0,0 +1,32 @@
+import { ScIPaginationParams, ScIRangeFilter, ScISortOrder } from '../../pagination';
+/**
+ * Данные о параметрах запроса списка коммерческих предложений/черновиков заказа.
+ */
+export interface ScIOrderDraftListParams extends Partial<ScIPaginationParams> {
+    /**
+     * Параметры сортировки.
+     */
+    order?: Partial<ScISortOrder<'number' | 'created'>>;
+    /**
+     * Фильтры.
+     */
+    filters?: {
+        /**
+         * Поиск по номеру, названиям товаров, синонимам товаров и маркировке.
+         */
+        search?: string;
+        /**
+         * Фильтр по номеру.
+         */
+        number?: ScIRangeFilter<number> & {
+            /**
+             * Список номеров которые необходимо вернуть.
+             */
+            in?: number[];
+        };
+        /**
+         * Фильтр по дате создания.
+         */
+        created?: ScIRangeFilter<string>;
+    };
+}

package/order/internal/sc-i-order-draft-short.d.ts

@@ -0,0 +1,15 @@
+import { ScOrderDraftType } from '../enums';
+import { ScIOrderBase } from './sc-i-order-base';
+/**
+ * Данные о кратком коммерческом предложении/черновике заказа.
+ */
+export interface ScIOrderDraftShort extends ScIOrderBase {
+    /**
+     * Название коммерческого предложения/черновика.
+     */
+    name?: string;
+    /**
+     * Тип коммерческого предложения/черновика.
+     */
+    type: ScOrderDraftType;
+}

package/order/internal/sc-i-order-draft.d.ts

@@ -0,0 +1,43 @@
+import { ScOrderDraft } from '../classes/sc-order-draft';
+import { ScOrderDraftShort } from '../classes/sc-order-draft-short';
+import { ScIOrderDraftShort } from './sc-i-order-draft-short';
+import { ScIOrderItem } from './sc-i-order-item';
+/**
+ * Данные о коммерческом предложении/черновике заказа.
+ */
+export interface ScIOrderDraft extends ScIOrderDraftShort {
+    /**
+     * Сумма коммерческого предложения/черновика.
+     */
+    sum: number;
+    /**
+     * Список продуктов коммерческого предложения/черновика.
+     */
+    products: ScIOrderItem[];
+    /**
+     * Возвращает сумму в виде строки. Если стоимость отсутствует, то вернёт '-'.
+     */
+    getSumStr(): string;
+    /**
+     * Возвращает сообщение о необходимости уточнить сумму или пустую строку.
+     */
+    getSumMessage(): string;
+    /**
+     * Возвращает признак того, что срок жизни информации не истёк.
+     *
+     * @param lifeTime Срок жизни данных в ms.
+     */
+    cachedDataIsActual(lifeTime: number): boolean;
+    /**
+     * Обновляет данные полного коммерческого предложения/черновика.
+     *
+     * @param offer Полная информация о коммерческом предложении/черновике.
+     */
+    updateData(offer: ScOrderDraft): void;
+    /**
+     * Обновляет данные краткой информацией. Не обновляет дату последнего обновления.
+     *
+     * @param offer Краткая информация о коммерческом предложении/черновике.
+     */
+    updateDataFromShortOffer(offer: ScOrderDraftShort): void;
+}