bx-rest 0.10.2 → 0.10.3

package/map/crm/index.d.ts

@@ -5,3 +5,4 @@ export * from './company';
 export * from './quote';
 export * from './automatedsolution';
 export * from './currency';
+export * from './status';

package/map/crm/status.d.ts

@@ -0,0 +1,9 @@
+import { iBXRestCrmStatus, iBXRestCrmStatusEntityType, iBXRestCrmStatusEntityTypeHttp, iBXRestCrmStatusHttp } from '../../typification/rest/crm';
+export declare class BXRestMapCrmStatus {
+    /** Преобразует список элементов справочника из формата Bitrix24 в локальный формат. */
+    static list(value: iBXRestCrmStatusHttp[] | undefined): iBXRestCrmStatus[] | undefined;
+    /** Преобразует элемент справочника из формата Bitrix24 в локальный формат. */
+    static get(value: iBXRestCrmStatusHttp | undefined): iBXRestCrmStatus | undefined;
+    /** Нормализует идентификаторы воронок в описаниях типов справочников. */
+    static entityTypes(value: iBXRestCrmStatusEntityTypeHttp[] | undefined): iBXRestCrmStatusEntityType[] | undefined;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-rest",
-  "version": "0.10.2",
+  "version": "0.10.3",
   "description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
   "keywords": [
     "bitrix",

package/request-navvy/crm/status/entity.d.ts

@@ -0,0 +1,20 @@
+import { iBXRestCrmStatusEntityItem, iBXRestCrmStatusEntityType, iBXRestCrmStatusEntityTypeHttp, iBXRestParamCrmStatusEntityItems } from '../../../typification/rest/crm';
+/** Навигатор методов описания типов справочников CRM (`crm.status.entity.*`). */
+export declare class BXRestNavvyCrmStatusEntity {
+    private readonly Navvy;
+    private readonly url;
+    /**
+     * Возвращает все элементы указанного справочника с сортировкой по полю `SORT`.
+     *
+     * @param param Символьный идентификатор справочника в поле `entityId`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-entity-items.html
+     */
+    items(param: iBXRestParamCrmStatusEntityItems): import("../../../services/navvy").NavvySimple<iBXRestCrmStatusEntityItem[], iBXRestCrmStatusEntityItem[], iBXRestParamCrmStatusEntityItems | undefined>;
+    /**
+     * Возвращает все поддерживаемые типы справочников и их символьные идентификаторы.
+     * Для справочников стадий ответ также содержит сведения о воронке и семантике.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-entity-types.html
+     */
+    types(): import("../../../services/navvy").NavvySimple<iBXRestCrmStatusEntityTypeHttp[], iBXRestCrmStatusEntityType[], undefined>;
+}

package/request-navvy/crm/status.d.ts

@@ -0,0 +1,54 @@
+import { iBXRestCrmStatus, iBXRestCrmStatusFields, iBXRestCrmStatusHttp, iBXRestParamCrmStatusAdd, iBXRestParamCrmStatusDelete, iBXRestParamCrmStatusGet, iBXRestParamCrmStatusList, iBXRestParamCrmStatusUpdate } from '../../typification/rest/crm';
+import { BXRestNavvyCrmStatusEntity } from './status/entity';
+export * from './status/entity';
+/** Навигатор REST-методов справочников CRM (`crm.status.*`). */
+export declare class BXRestNavvyCrmStatus {
+    private readonly Navvy;
+    private readonly url;
+    /** Типы справочников и получение их элементов (`crm.status.entity.*`). */
+    readonly entity: BXRestNavvyCrmStatusEntity;
+    /**
+     * Создает новый элемент в указанном справочнике CRM.
+     * Для стадий пользовательских воронок Bitrix24 автоматически добавляет к `STATUS_ID` префикс воронки.
+     *
+     * @param param Тип справочника и поля нового элемента.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-add.html
+     */
+    add(param: iBXRestParamCrmStatusAdd): import("../../services/navvy").NavvySimple<number, number, iBXRestParamCrmStatusAdd | undefined>;
+    /**
+     * Обновляет название, сортировку или цвет существующего элемента справочника.
+     *
+     * @param param Идентификатор элемента и изменяемые поля.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-update.html
+     */
+    update(param: iBXRestParamCrmStatusUpdate): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmStatusUpdate | undefined>;
+    /**
+     * Возвращает элемент справочника по числовому идентификатору.
+     *
+     * @param param Идентификатор элемента справочника.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-get.html
+     */
+    get(param: iBXRestParamCrmStatusGet): import("../../services/navvy").NavvySimple<iBXRestCrmStatusHttp, iBXRestCrmStatus, import("../../typification/rest/crm").iBXRestParamCrmStatusId | undefined>;
+    /**
+     * Возвращает список элементов справочников по фильтру с заданной сортировкой.
+     * Навигатор поддерживает получение всех страниц результата через `resAll()`.
+     *
+     * @param param Фильтр, сортировка и начальная позиция страницы.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-list.html
+     */
+    list(param?: iBXRestParamCrmStatusList): import("../../services/navvy").NavvyPag<iBXRestCrmStatusHttp, iBXRestCrmStatus, iBXRestParamCrmStatusList>;
+    /**
+     * Удаляет элемент справочника.
+     * Для системного элемента передайте `params.FORCED: 'Y'`.
+     *
+     * @param param Идентификатор элемента и необязательный флаг принудительного удаления.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-delete.html
+     */
+    delete(param: iBXRestParamCrmStatusDelete): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmStatusDelete | undefined>;
+    /**
+     * Возвращает описание полей элементов справочников CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-fields.html
+     */
+    fields(): import("../../services/navvy").NavvySimple<iBXRestCrmStatusFields, iBXRestCrmStatusFields, undefined>;
+}

package/request-navvy/crm.d.ts

@@ -9,7 +9,10 @@ import { BXRestNavvyCrmAutomation } from './crm/automation/index';
 import { BXRestNavvyCrmAutomatedSolution } from './crm/automatedsolution';
 import { BXRestNavvyCrmDocumentGenerator } from './crm/documentgenerator/index';
 import { BXRestNavvyCrmCurrency } from './crm/currency';
+import { BXRestNavvyCrmStatus } from './crm/status';
 export declare class BXRestNavvyCrm {
+    /** Справочники CRM (`crm.status.*`). */
+    readonly status: BXRestNavvyCrmStatus;
     /** Валюты CRM (`crm.currency.*`). */
     readonly currency: BXRestNavvyCrmCurrency;
     /** Генератор документов CRM (`crm.documentgenerator.*`). */

package/typification/rest/crm/index.d.ts

@@ -9,3 +9,4 @@ export * from './automation';
 export * from './automatedsolution';
 export * from './documentgenerator';
 export * from './currency';
+export * from './status';

package/typification/rest/crm/status.d.ts

@@ -0,0 +1,167 @@
+import { iBXRestPagination } from '../base/api-pagination-bx';
+import { iBXRestParamSort } from '../base/sort';
+import { iBXRestYesNo } from '../base/yes-no';
+import { iBXRestCrmFieldDescription } from './enum';
+/** Группа стадии: успех, провал или стадия в работе. */
+export type iBXRestCrmStatusSemantics = 'S' | 'F' | '';
+/** Поля нового элемента справочника CRM. */
+export interface iBXRestCrmStatusAddFields {
+    /** Символьный идентификатор справочника, например `DEAL_STAGE` или `SOURCE`. */
+    ENTITY_ID: string;
+    /** Уникальный в рамках справочника код значения. */
+    STATUS_ID: string;
+    /** Отображаемое название значения. */
+    NAME: string;
+    /** Позиция значения в справочнике. По умолчанию 10. */
+    SORT?: number;
+    /** Цвет стадии в формате hex, например `#39A8EF`. */
+    COLOR?: string;
+    /** Группа стадии: `S` — успех, `F` — провал, пустая строка — в работе. */
+    SEMANTICS?: iBXRestCrmStatusSemantics;
+}
+/** Изменяемые поля элемента справочника CRM. */
+export interface iBXRestCrmStatusUpdateFields {
+    /** Новое отображаемое название. */
+    NAME?: string;
+    /** Новая позиция в справочнике. */
+    SORT?: number;
+    /** Новый цвет стадии в формате hex. */
+    COLOR?: string;
+}
+/** Параметры метода `crm.status.add`. */
+export interface iBXRestParamCrmStatusAdd {
+    /** Поля нового элемента справочника. */
+    fields: iBXRestCrmStatusAddFields;
+}
+/** Параметры метода `crm.status.update`. */
+export interface iBXRestParamCrmStatusUpdate {
+    /** Числовой идентификатор изменяемого элемента. */
+    id: number;
+    /** Изменяемые поля элемента справочника. */
+    fields: iBXRestCrmStatusUpdateFields;
+}
+/** Параметры методов, принимающих идентификатор элемента справочника. */
+export interface iBXRestParamCrmStatusId {
+    /** Числовой идентификатор элемента справочника. */
+    id: number;
+}
+/** Параметры метода `crm.status.get`. */
+export type iBXRestParamCrmStatusGet = iBXRestParamCrmStatusId;
+/** Параметры метода `crm.status.delete`. */
+export interface iBXRestParamCrmStatusDelete extends iBXRestParamCrmStatusId {
+    params?: {
+        /** Разрешает удалить системный элемент справочника. По умолчанию `N`. */
+        FORCED?: iBXRestYesNo;
+    };
+}
+/** Поля элемента справочника, доступные для сортировки и фильтрации. */
+export type iBXRestCrmStatusField = 'ID' | 'ENTITY_ID' | 'STATUS_ID' | 'SORT' | 'NAME' | 'NAME_INIT' | 'SYSTEM' | 'CATEGORY_ID' | 'COLOR' | 'SEMANTICS' | 'EXTRA';
+/** Параметры метода `crm.status.list`. */
+export interface iBXRestParamCrmStatusList extends iBXRestPagination {
+    /** Порядок сортировки элементов по полям справочника. */
+    order?: Partial<Record<iBXRestCrmStatusField, iBXRestParamSort>>;
+    /** Фильтр по полям справочника, включая REST-префиксы операторов. */
+    filter?: Record<string, any>;
+}
+/** Параметры метода `crm.status.entity.items`. */
+export interface iBXRestParamCrmStatusEntityItems {
+    /** Символьный идентификатор справочника, например `DEAL_STAGE` или `SOURCE`. */
+    entityId: string;
+}
+/** Дополнительные данные элемента справочника. */
+export interface iBXRestCrmStatusExtra extends Record<string, any> {
+    /** Семантика стадии в человекочитаемом формате. */
+    SEMANTICS?: string;
+    /** Цвет стадии в формате hex. */
+    COLOR?: string;
+}
+interface iBXRestCrmStatusBase {
+    /** Символьный идентификатор справочника. */
+    ENTITY_ID: string;
+    /** Код значения, используемый в полях элементов CRM. */
+    STATUS_ID: string;
+    /** Отображаемое название. */
+    NAME: string;
+    /** Исходное системное название. */
+    NAME_INIT: string;
+    /** Цвет стадии в формате hex. */
+    COLOR: string;
+    /** Группа стадии. */
+    SEMANTICS: iBXRestCrmStatusSemantics | null;
+    /** Дополнительные данные элемента. */
+    EXTRA?: iBXRestCrmStatusExtra;
+}
+/** Элемент справочника CRM в локальном формате библиотеки. */
+export interface iBXRestCrmStatus extends iBXRestCrmStatusBase {
+    /** Числовой идентификатор элемента. */
+    ID: number;
+    /** Позиция элемента в справочнике. */
+    SORT: number;
+    /** Является ли элемент системным. */
+    SYSTEM: boolean;
+    /** Идентификатор воронки для статуса-стадии. */
+    CATEGORY_ID: number | null;
+}
+/** Элемент справочника CRM в формате ответа Bitrix24. */
+export interface iBXRestCrmStatusHttp extends iBXRestCrmStatusBase {
+    ID: string;
+    SORT: string;
+    SYSTEM: iBXRestYesNo;
+    CATEGORY_ID: string | null;
+}
+/** Краткое представление элемента, возвращаемое `crm.status.entity.items`. */
+export interface iBXRestCrmStatusEntityItem {
+    /** Отображаемое название. */
+    NAME: string;
+    /** Позиция элемента в справочнике. */
+    SORT: number;
+    /** Код значения, используемый в полях элементов CRM. */
+    STATUS_ID: string;
+}
+/** Семантические границы справочника стадий. */
+export interface iBXRestCrmStatusSemanticInfo {
+    /** Код начальной стадии. */
+    START_FIELD: string;
+    /** Код успешной финальной стадии. */
+    FINAL_SUCCESS_FIELD: string;
+    /** Код неуспешной финальной стадии. */
+    FINAL_UNSUCCESS_FIELD: string;
+    /** Позиция финальной стадии. */
+    FINAL_SORT: number;
+}
+interface iBXRestCrmStatusEntityTypeBase {
+    /** Символьный идентификатор справочника для параметра `ENTITY_ID`. */
+    ID: string;
+    /** Отображаемое название справочника. */
+    NAME: string;
+    /** Тип объекта CRM, к которому относится справочник стадий. */
+    ENTITY_TYPE_ID?: number;
+    /** Семантические границы стадий; некоторые типы API возвращают пустой массив. */
+    SEMANTIC_INFO?: iBXRestCrmStatusSemanticInfo | [];
+    /** Префикс кода стадии воронки. */
+    PREFIX?: string;
+    /** Область применения поля, соответствующая воронке. */
+    FIELD_ATTRIBUTE_SCOPE?: string;
+    /** Активен ли тип справочника. */
+    IS_ENABLED?: boolean;
+    /** Идентификатор родительского справочника. */
+    PARENT_ID?: string;
+    /** Название воронки. */
+    CATEGORY_NAME?: string;
+    /** Позиция воронки. */
+    CATEGORY_SORT?: number;
+    /** Является ли воронка воронкой по умолчанию. */
+    IS_DEFAULT_CATEGORY?: boolean;
+}
+/** Описание типа справочника в локальном формате библиотеки. */
+export interface iBXRestCrmStatusEntityType extends iBXRestCrmStatusEntityTypeBase {
+    /** Идентификатор воронки. */
+    CATEGORY_ID?: number;
+}
+/** Описание типа справочника в формате ответа Bitrix24. */
+export interface iBXRestCrmStatusEntityTypeHttp extends iBXRestCrmStatusEntityTypeBase {
+    CATEGORY_ID?: number | string;
+}
+/** Описание полей, возвращаемое методом `crm.status.fields`. */
+export type iBXRestCrmStatusFields = Record<iBXRestCrmStatusField, iBXRestCrmFieldDescription>;
+export {};