@snabcentr/client-core 3.7.0 → 4.0.0

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

@@ -1,29 +0,0 @@
-/**
- * Перечисление типов отплат заказа.
- */
-export declare enum ScPaymentType {
-    /**
-     * Оплата наличными.
-     */
-    nal = 1,
-    /**
-     * Онлайн оплата.
-     */
-    online = 2,
-    /**
-     * Безналичный расчёт (без НДС).
-     */
-    beznal = 3,
-    /**
-     * Безналичный расчёт (с НДС).
-     */
-    beznal2 = 4,
-    /**
-     * Банковская карта.
-     */
-    terminal = 5,
-    /**
-     * Оплата через систему быстрых платежей.
-     */
-    sbp = 6
-}

package/order/index.d.ts

@@ -1,5 +0,0 @@
-export * from './classes';
-export * from './enums';
-export * from './internal';
-export * from './services';
-export * from './tokens';

package/order/internal/index.d.ts

@@ -1,14 +0,0 @@
-export * from './sc-i-new-order-draft-request';
-export * from './sc-i-delivery-cost-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,20 +0,0 @@
-/**
- * Данные о стоимости доставки (DTO).
- *
- * @internal
- */
-export interface ScIDeliveryCostDTO {
-    /**
-     * Данные о бесплатной доставке.
-     */
-    freeShippingTerms?: {
-        /**
-         * Минимальная сумма бесплатной доставки.
-         */
-        minOrdersSum?: number;
-        /**
-         * Общая сумма всех текущих заказов и корзины.
-         */
-        currentOrdersSum?: number;
-    };
-}

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

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

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

@@ -1,21 +0,0 @@
-/**
- * Данные о товаре для добавления в корзину.
- */
-export interface ScINewOrderItemBase {
-    /**
-     * Идентификатор записи товара/услуги.
-     */
-    productId?: number;
-    /**
-     * Идентификатор категории. Используется при добавлении продукта через конфигуратор.
-     */
-    productCategoryId?: number;
-    /**
-     * Количество товара/услуги.
-     */
-    quantity: number;
-    /**
-     * Описание позиции.
-     */
-    marker?: string;
-}

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

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

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

@@ -1,48 +0,0 @@
-import { ScUploadedFile } from '../../contacts/dto/sc-uploaded-file';
-import { ScUTM } from '../../utm/interfaces';
-import { ScDeliveryType, ScPaymentType } from '../enums';
-/**
- * Данные о новом заказе.
- */
-export interface ScINewOrder {
-    /**
-     * Тип оплаты.
-     */
-    paymentType: ScPaymentType;
-    /**
-     * Тип доставки.
-     */
-    deliveryType: ScDeliveryType;
-    /**
-     * Идентификатор контрагента клиента. Значение обязательно в случае если клиент юр. лицо.
-     */
-    contragentId?: number;
-    /**
-     * Желаемая дата доставки или самовывоза.
-     */
-    deliveryDate: string;
-    /**
-     * Идентификатор адреса доставки контрагента клиента. Значение обязательно при типе доставки "Доставка".
-     */
-    addressId?: number;
-    /**
-     * Идентификатор склада. Значение обязательно при типе доставки "Самовывоз".
-     */
-    warehouseId?: number;
-    /**
-     * Загружаемый пользователем файл, содержимое которого кодировано в base64.
-     */
-    image?: ScUploadedFile;
-    /**
-     * Комментарий клиента к заказу.
-     */
-    comment?: string;
-    /**
-     * Список идентификаторов элементов корзины, которые попадут в заказ.
-     */
-    items?: Array<number | string>;
-    /**
-     * Данные о UTM-метке.
-     */
-    utm?: ScUTM;
-}

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

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

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

@@ -1,32 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,43 +0,0 @@
-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;
-}

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

@@ -1,91 +0,0 @@
-import { ScIProduct } from '../../catalog/interfaces/sc-i-product';
-import { ScIConfiguratorSearchProductBase } from '../../configurator/dto/sc-i-configurator-search-product-base';
-/**
- * Данные о единичной позиции товара/услуги в заказе.
- */
-export interface ScIOrderItem {
-    /**
-     * Идентификатор позиции.
-     */
-    id: string;
-    /**
-     * Данные о товаре. Равен `null` если товар отсутствует.
-     */
-    product: ScIProduct | null;
-    /**
-     * Количество товара/услуги.
-     */
-    quantity: number;
-    /**
-     * Итоговая стоимость товара или услуги в валюте.
-     */
-    cost: number;
-    /**
-     * Стоимость единицы товара или услуги в валюте.
-     */
-    costOne: number;
-    /**
-     * Стоимость единицы товара или услуги в рублях.
-     */
-    costOneRub: number;
-    /**
-     * Итоговая стоимость позиции корзины.
-     */
-    costRub: number;
-    /**
-     * Описание позиции.
-     */
-    marker?: string;
-    /**
-     * Высота товара.
-     */
-    height?: number;
-    /**
-     * Длина товара.
-     */
-    length?: number;
-    /**
-     * Ширина товара.
-     */
-    width?: number;
-    /**
-     * Идентификатор логической группы товаров/услуг.
-     */
-    logicGroupId?: string;
-    /**
-     * Направление продаж.
-     */
-    salesDirection?: number;
-    /**
-     * URL изображения со спецификацией.
-     */
-    specificationImgUrl?: string;
-    /**
-     * Название конфигуратора.
-     */
-    configurator?: string;
-    /**
-     * Параметры введенные в конфигуратор, при добавлении позиции в корзину.
-     */
-    configuratorParams?: ScIConfiguratorSearchProductBase;
-    /**
-     * Возвращает стоимость единицы товара (включая валюту). Если стоимость отсутствует, то вернёт '-'.
-     */
-    getCostPerItem(): string;
-    /**
-     * Возвращает строковое представление стоимости единицы товара (включая единицу измерения) в валюте. Если стоимость отсутствует, то вернёт '-'.
-     */
-    getCostInCurrencyDescPerItem(): string;
-    /**
-     * Возвращает строковое представление стоимости единицы товара (включая единицу измерения) в рублях. Если стоимость отсутствует, то вернёт '-'.
-     */
-    getCostInRubDescPerItem(): string;
-    /**
-     * Возвращает стоимость товара в виде строки. Если стоимость отсутствует, то вернёт '-'.
-     */
-    getCostRubStr(): string;
-    /**
-     * Возвращает сообщение о необходимости уточнить цену или пустую строку.
-     */
-    getCostMessage(): string;
-}

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

@@ -1,51 +0,0 @@
-import { Observable } from 'rxjs';
-import { ScOrderItem } from '../classes/sc-order-item';
-import { ScOrderLoading } from '../tokens/sc-order-loader.token';
-import { ScINewOrderItemBase } from './sc-i-new-order-item-base';
-/**
- * Данные о загрузчике списка товаров заказа (корзина / заказ / черновик).
- *
- * @template TItem Тип элемента списка ({@link ScOrderItem} — единичная позиция в корзине/заказе/черновике).
- * @template TContext Тип полной сущности заказа (корзина / заказ / черновик) для get$().
- */
-export interface ScIOrderLoader<TItem extends ScOrderItem = ScOrderItem, TContext = unknown> {
-    /**
-     * Возвращает полную информацию о заказе (корзине / черновике).
-     *
-     * @param id Опциональный идентификатор заказа (корзины / черновика).
-     */
-    get$(id?: number): Observable<TContext | ScOrderLoading>;
-    /**
-     * Возвращает список элементов заказа (корзины / черновика).
-     *
-     * @param id Опциональный идентификатор заказа (корзины / черновика).
-     */
-    getItems$(id?: number): Observable<TItem[] | ScOrderLoading>;
-}
-/**
- * Данные о загрузчике заказа с редактированием и удалением позиций.
- */
-export interface ScIOrderEditorLoader<TItem extends ScOrderItem = ScOrderItem, TContext = unknown> extends ScIOrderLoader<TItem, TContext> {
-    /**
-     * Добавляет продукт в заказ (корзину / черновик).
-     *
-     * @param data Данные добавляемого продукта ({@link ScINewOrderItemBase}).
-     * @param contextId Опциональный идентификатор контекста (например, идентификатор черновика/предложения).
-     */
-    addProduct$(data: ScINewOrderItemBase, contextId?: number): Observable<TContext | ScOrderLoading>;
-    /**
-     * Изменяет продукт в заказе (корзине / черновике).
-     *
-     * @param id Идентификатор позиции.
-     * @param patch Частичные данные для обновления.
-     * @param contextId Опциональный идентификатор контекста (например, идентификатор черновика/предложения).
-     */
-    updateProduct$(id: string, patch: Omit<ScINewOrderItemBase, 'productId'>, contextId?: number): Observable<TContext | ScOrderLoading>;
-    /**
-     * Удаляет продукт из заказа (корзины / черновика).
-     *
-     * @param item Удаляемая позиция.
-     * @param contextId Опциональный идентификатор контекста (например, идентификатор черновика/предложения).
-     */
-    deleteProduct$(item: TItem, contextId?: number): Observable<TContext | ScOrderLoading>;
-}

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

@@ -1,48 +0,0 @@
-import { ScIReferencesTypes, ScISalesDirection, ScOrderStateStatus } from '../../references';
-import { ScIOrderDelivery } from '../classes/sc-order-delivery';
-import { ScIOrderPayment } from '../classes/sc-order-payment';
-import { ScOrderShort } from '../classes/sc-order-short';
-import { ScIOrderBase } from './sc-i-order-base';
-/**
- * Данные о кратком заказе.
- */
-export interface ScIOrderShort extends ScIOrderBase {
-    /**
-     * Идентификатор статуса.
-     */
-    status: ScIReferencesTypes<number, ScOrderStateStatus>;
-    /**
-     * Детализирующий статус заказа.
-     */
-    statusDetail: ScIReferencesTypes<number, ScOrderStateStatus>;
-    /**
-     * Данные о направлении продаж.
-     */
-    salesDirection: ScISalesDirection;
-    /**
-     * Данные об оплате заказа.
-     */
-    payment: ScIOrderPayment;
-    /**
-     * Данные о доставке заказа.
-     */
-    delivery: ScIOrderDelivery;
-    /**
-     * Сумма заказа.
-     */
-    sum: number;
-    /**
-     * Номер документа в учетной системе клиента.
-     */
-    numberDoc?: number;
-    /**
-     * Штрих-код заказа.
-     */
-    barcode?: number;
-    /**
-     * Обновляет данные заказа.
-     *
-     * @param order Краткая информация о заказе.
-     */
-    updateData(order: ScOrderShort): void;
-}

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

@@ -1,112 +0,0 @@
-import { ScContragent } from '../../contragent/dto/sc-contragent';
-import { ScIReferencesTypes } from '../../references/dto/sc-i-references-types';
-import { ScOrderStateStatus } from '../../references/enums/sc-order-state-status';
-import { ScIOrderHistory } from '../classes/sc-i-order-history';
-import { ScOrderShort } from '../classes/sc-order-short';
-import { ScDeliveryType, ScPaymentType } from '../enums';
-import { ScIOrderItem } from './sc-i-order-item';
-import { ScIOrderShort } from './sc-i-order-short';
-/**
- * Данные о заказе.
- */
-export interface ScIOrder extends ScIOrderShort {
-    /**
-     * Список продуктов заказа.
-     */
-    readonly products: ScIOrderItem[];
-    /**
-     * Список статусов, в которые текущий пользователь может перевести заказ.
-     */
-    readonly nextStatuses?: Array<ScIReferencesTypes<number, ScOrderStateStatus>>;
-    /**
-     * Список записей истории изменения статусов заказа.
-     */
-    readonly history?: ScIOrderHistory[];
-    /**
-     * Список счетов заказа.
-     */
-    readonly invoices?: string[];
-    /**
-     * Комментарий клиента к заказу.
-     */
-    readonly comment?: string;
-    /**
-     * Изображение, прикрепленное к заказу клиентом во время создания.
-     */
-    readonly image?: string;
-    /**
-     * Данные о контрагенте клиента.
-     */
-    readonly contragent?: ScContragent;
-    /**
-     * Закрепленный за заказом пользователь.
-     */
-    readonly attachedUser?: {
-        /**
-         * Тип пользователя.
-         */
-        type: string;
-        /**
-         * ФИО пользователя.
-         */
-        name: string;
-        /**
-         * Номер телефона в международном формате, например `+7XXXXXXXXXX`.
-         */
-        phone: string;
-        /**
-         * Адрес электронной почты.
-         */
-        email: string;
-    };
-    /**
-     * Список тегов заказа.
-     */
-    readonly tags?: string[];
-    /**
-     * Дата последнего обновления статуса и информации об оплате.
-     */
-    readonly lastUpdateDate: Date;
-    /**
-     * Тип оплаты.
-     */
-    readonly paymentType: ScPaymentType;
-    /**
-     * Тип доставки.
-     */
-    readonly deliveryType: ScDeliveryType;
-    /**
-     * Признак, что заказ можно оплатить online.
-     */
-    readonly isPayable: boolean;
-    /**
-     * Признак, что заказ будет подлежать online-оплате.
-     */
-    readonly isPayableSoon: boolean;
-    /**
-     * Признак, что заказ завершён.
-     */
-    readonly isCompleted: boolean;
-    /**
-     * Признак, что заказ может быть отменен.
-     */
-    readonly isCanBeCanceled: boolean;
-    /**
-     * Возвращает признак того, что срок жизни информации о заказе не истёк.
-     *
-     * @param orderLifeTime Срок жизни данных в ms.
-     */
-    cachedDataIsActual(orderLifeTime: number): boolean;
-    /**
-     * Обновляет данные полного заказа.
-     *
-     * @param order Полная информация о заказе.
-     */
-    updateData(order: ScOrderShort): void;
-    /**
-     * Обновляет данные полного заказа данными краткой информации о заказе. Не обновляете дату последнего обновления.
-     *
-     * @param order Краткая информация о заказе.
-     */
-    updateDataFromShortOrder(order: ScOrderShort): void;
-}

package/order/internal/sc-i-update-order-order-request.d.ts

@@ -1,9 +0,0 @@
-/**
- * Данные о запросе на обновление коммерческого предложения/черновика заказа.
- */
-export interface ScIUpdateOrderDraftRequest {
-    /**
-     * Название коммерческого предложения/черновика.
-     */
-    name?: string;
-}

package/order/services/index.d.ts

@@ -1,2 +0,0 @@
-export * from './sc-order-drafts.service';
-export * from './sc-orders.service';