bx-rest 0.10.1 → 0.10.3

package/fesm2022/bx-rest.mjs

@@ -1032,6 +1032,7 @@ const $deal = 'deal';
 const $contact = 'contact';
 const $company = 'company';
 const $quote = 'quote';
+const $currency = 'currency';
 const $productrows = 'productrows';
 const $documentgenerator = 'documentgenerator';
 const $numerator = 'numerator';
@@ -1068,6 +1069,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $counters: $counters,
     $create: $create,
     $crm: $crm,
+    $currency: $currency,
     $deal: $deal,
     $defer: $defer,
     $delegate: $delegate,
@@ -6189,6 +6191,64 @@ class BXRestMapCrmAutomatedSolution {
     }
 }
 
+class BXRestMapCrmCurrency {
+    /** Преобразует список валют из формата Bitrix24 в локальный формат библиотеки. */
+    static list(value) {
+        return value?.map(item => BXRestMapCrmCurrency.get(item));
+    }
+    /** Преобразует валюту из формата Bitrix24 в локальный формат библиотеки. */
+    static get(value) {
+        if (!value)
+            return undefined;
+        return Object.assign(clone(value), {
+            AMOUNT_CNT: toNum(value.AMOUNT_CNT),
+            AMOUNT: toNum(value.AMOUNT),
+            SORT: toNum(value.SORT),
+            BASE: toBool(value.BASE),
+            DECIMALS: toNum(value.DECIMALS),
+            DATE_UPDATE: toDate(value.DATE_UPDATE),
+            LANG: BXRestMapCrmCurrency.localizations(value.LANG)
+        });
+    }
+    static localizations(value) {
+        if (!value)
+            return undefined;
+        return Object.fromEntries(Object.entries(value).map(([language, localization]) => [
+            language,
+            Object.assign(clone(localization), {
+                DECIMALS: toNum(localization.DECIMALS),
+                HIDE_ZERO: localization.HIDE_ZERO === undefined
+                    ? undefined
+                    : toBool(localization.HIDE_ZERO)
+            })
+        ]));
+    }
+}
+
+class BXRestMapCrmStatus {
+    /** Преобразует список элементов справочника из формата Bitrix24 в локальный формат. */
+    static list(value) {
+        return value?.map(item => BXRestMapCrmStatus.get(item));
+    }
+    /** Преобразует элемент справочника из формата Bitrix24 в локальный формат. */
+    static get(value) {
+        if (!value)
+            return undefined;
+        return Object.assign(clone(value), {
+            ID: toNum(value.ID),
+            SORT: toNum(value.SORT),
+            SYSTEM: toBool(value.SYSTEM),
+            CATEGORY_ID: value.CATEGORY_ID === null ? null : toNum(value.CATEGORY_ID)
+        });
+    }
+    /** Нормализует идентификаторы воронок в описаниях типов справочников. */
+    static entityTypes(value) {
+        return value?.map(item => Object.assign(clone(item), {
+            CATEGORY_ID: item.CATEGORY_ID === undefined ? undefined : toNum(item.CATEGORY_ID)
+        }));
+    }
+}
+
 class BXRestNavvyCrmLead {
     constructor() {
         this.url = {
@@ -7166,8 +7226,213 @@ class BXRestNavvyCrmDocumentGenerator {
     }
 }
 
+/** Методы управления базовой валютой (`crm.currency.base.*`). */
+class BXRestNavvyCrmCurrencyBase {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            get: [$crm, $currency, 'base', $get],
+            set: [$crm, $currency, 'base', $set]
+        };
+    }
+    /**
+     * Возвращает символьный идентификатор базовой валюты.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-base-get.html
+     */
+    get() {
+        return this.Navvy.simple(this.url.get);
+    }
+    /**
+     * Устанавливает указанную валюту в качестве базовой.
+     * После смены базовой валюты курсы остальных валют необходимо обновить вручную.
+     *
+     * @param param Символьный идентификатор новой базовой валюты.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-base-set.html
+     */
+    set(param) {
+        return this.Navvy.simple(this.url.set, param);
+    }
+}
+
+/** Навигатор REST-методов валют CRM (`crm.currency.*`). */
+class BXRestNavvyCrmCurrency {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            add: [$crm, $currency, $add],
+            update: [$crm, $currency, $update],
+            get: [$crm, $currency, $get],
+            list: [$crm, $currency, $list],
+            delete: [$crm, $currency, $delete],
+            fields: [$crm, $currency, 'fields']
+        };
+        /** Базовая валюта (`crm.currency.base.*`). */
+        this.base = new BXRestNavvyCrmCurrencyBase();
+    }
+    /**
+     * Создает новую валюту.
+     *
+     * @param param Поля новой валюты, включая код ISO 4217, номинал и курс.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param);
+    }
+    /**
+     * Обновляет существующую валюту.
+     *
+     * @param param Идентификатор валюты и изменяемые поля.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-update.html
+     */
+    update(param) {
+        return this.Navvy.simple(this.url.update, param);
+    }
+    /**
+     * Возвращает валюту по символьному идентификатору.
+     *
+     * @param param Символьный идентификатор валюты по ISO 4217.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param, BXRestMapCrmCurrency.get);
+    }
+    /**
+     * Возвращает список валют с локализацией для текущего языка портала.
+     *
+     * @param param Необязательный порядок сортировки.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-list.html
+     */
+    list(param = {}) {
+        return this.Navvy.simple(this.url.list, param, BXRestMapCrmCurrency.list);
+    }
+    /**
+     * Удаляет валюту.
+     *
+     * @param param Символьный идентификатор удаляемой валюты.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+    /**
+     * Возвращает описание полей валюты.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-fields.html
+     */
+    fields() {
+        return this.Navvy.simple(this.url.fields);
+    }
+}
+
+/** Навигатор методов описания типов справочников CRM (`crm.status.entity.*`). */
+class BXRestNavvyCrmStatusEntity {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            items: [$crm, $status, 'entity', 'items'],
+            types: [$crm, $status, 'entity', 'types']
+        };
+    }
+    /**
+     * Возвращает все элементы указанного справочника с сортировкой по полю `SORT`.
+     *
+     * @param param Символьный идентификатор справочника в поле `entityId`.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-entity-items.html
+     */
+    items(param) {
+        return this.Navvy.simple(this.url.items, param);
+    }
+    /**
+     * Возвращает все поддерживаемые типы справочников и их символьные идентификаторы.
+     * Для справочников стадий ответ также содержит сведения о воронке и семантике.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-entity-types.html
+     */
+    types() {
+        return this.Navvy.simple(this.url.types, undefined, BXRestMapCrmStatus.entityTypes);
+    }
+}
+
+/** Навигатор REST-методов справочников CRM (`crm.status.*`). */
+class BXRestNavvyCrmStatus {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            add: [$crm, $status, $add],
+            update: [$crm, $status, $update],
+            get: [$crm, $status, $get],
+            list: [$crm, $status, $list],
+            delete: [$crm, $status, $delete],
+            fields: [$crm, $status, 'fields']
+        };
+        /** Типы справочников и получение их элементов (`crm.status.entity.*`). */
+        this.entity = new BXRestNavvyCrmStatusEntity();
+    }
+    /**
+     * Создает новый элемент в указанном справочнике CRM.
+     * Для стадий пользовательских воронок Bitrix24 автоматически добавляет к `STATUS_ID` префикс воронки.
+     *
+     * @param param Тип справочника и поля нового элемента.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param);
+    }
+    /**
+     * Обновляет название, сортировку или цвет существующего элемента справочника.
+     *
+     * @param param Идентификатор элемента и изменяемые поля.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-update.html
+     */
+    update(param) {
+        return this.Navvy.simple(this.url.update, param);
+    }
+    /**
+     * Возвращает элемент справочника по числовому идентификатору.
+     *
+     * @param param Идентификатор элемента справочника.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param, BXRestMapCrmStatus.get);
+    }
+    /**
+     * Возвращает список элементов справочников по фильтру с заданной сортировкой.
+     * Навигатор поддерживает получение всех страниц результата через `resAll()`.
+     *
+     * @param param Фильтр, сортировка и начальная позиция страницы.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-list.html
+     */
+    list(param = {}) {
+        return this.Navvy.pagNav(this.url.list, param, BXRestMapCrmStatus.list);
+    }
+    /**
+     * Удаляет элемент справочника.
+     * Для системного элемента передайте `params.FORCED: 'Y'`.
+     *
+     * @param param Идентификатор элемента и необязательный флаг принудительного удаления.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+    /**
+     * Возвращает описание полей элементов справочников CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-fields.html
+     */
+    fields() {
+        return this.Navvy.simple(this.url.fields);
+    }
+}
+
 class BXRestNavvyCrm {
     constructor() {
+        /** Справочники CRM (`crm.status.*`). */
+        this.status = new BXRestNavvyCrmStatus();
+        /** Валюты CRM (`crm.currency.*`). */
+        this.currency = new BXRestNavvyCrmCurrency();
         /** Генератор документов CRM (`crm.documentgenerator.*`). */
         this.documentGenerator = new BXRestNavvyCrmDocumentGenerator();
         /** Цифровые рабочие места (`crm.automatedsolution.*`). */