bx-rest 0.10.1 → 0.10.2

package/map/crm/currency.d.ts

@@ -0,0 +1,8 @@
+import { iBXRestCrmCurrency, iBXRestCrmCurrencyHttp } from '../../typification/rest/crm';
+export declare class BXRestMapCrmCurrency {
+    /** Преобразует список валют из формата Bitrix24 в локальный формат библиотеки. */
+    static list(value: iBXRestCrmCurrencyHttp[] | undefined): iBXRestCrmCurrency[] | undefined;
+    /** Преобразует валюту из формата Bitrix24 в локальный формат библиотеки. */
+    static get(value: iBXRestCrmCurrencyHttp | undefined): iBXRestCrmCurrency | undefined;
+    private static localizations;
+}

package/map/crm/index.d.ts

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

package/package.json

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

package/request-navvy/crm/currency/base.d.ts

@@ -0,0 +1,20 @@
+import { iBXRestParamCrmCurrencyBaseSet } from '../../../typification/rest/crm';
+/** Методы управления базовой валютой (`crm.currency.base.*`). */
+export declare class BXRestNavvyCrmCurrencyBase {
+    private readonly Navvy;
+    private readonly url;
+    /**
+     * Возвращает символьный идентификатор базовой валюты.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-base-get.html
+     */
+    get(): import("../../../services/navvy").NavvySimple<string, string, undefined>;
+    /**
+     * Устанавливает указанную валюту в качестве базовой.
+     * После смены базовой валюты курсы остальных валют необходимо обновить вручную.
+     *
+     * @param param Символьный идентификатор новой базовой валюты.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-base-set.html
+     */
+    set(param: iBXRestParamCrmCurrencyBaseSet): import("../../../services/navvy").NavvySimple<boolean, boolean, import("../../../typification/rest/crm").iBXRestParamCrmCurrencyId | undefined>;
+}

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

@@ -0,0 +1,51 @@
+import { iBXRestCrmCurrency, iBXRestCrmCurrencyFields, iBXRestCrmCurrencyHttp, iBXRestParamCrmCurrencyAdd, iBXRestParamCrmCurrencyDelete, iBXRestParamCrmCurrencyGet, iBXRestParamCrmCurrencyList, iBXRestParamCrmCurrencyUpdate } from '../../typification/rest/crm';
+import { BXRestNavvyCrmCurrencyBase } from './currency/base';
+export * from './currency/base';
+/** Навигатор REST-методов валют CRM (`crm.currency.*`). */
+export declare class BXRestNavvyCrmCurrency {
+    private readonly Navvy;
+    private readonly url;
+    /** Базовая валюта (`crm.currency.base.*`). */
+    readonly base: BXRestNavvyCrmCurrencyBase;
+    /**
+     * Создает новую валюту.
+     *
+     * @param param Поля новой валюты, включая код ISO 4217, номинал и курс.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-add.html
+     */
+    add(param: iBXRestParamCrmCurrencyAdd): import("../../services/navvy").NavvySimple<string, string, iBXRestParamCrmCurrencyAdd | undefined>;
+    /**
+     * Обновляет существующую валюту.
+     *
+     * @param param Идентификатор валюты и изменяемые поля.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-update.html
+     */
+    update(param: iBXRestParamCrmCurrencyUpdate): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmCurrencyUpdate | undefined>;
+    /**
+     * Возвращает валюту по символьному идентификатору.
+     *
+     * @param param Символьный идентификатор валюты по ISO 4217.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-get.html
+     */
+    get(param: iBXRestParamCrmCurrencyGet): import("../../services/navvy").NavvySimple<iBXRestCrmCurrencyHttp, iBXRestCrmCurrency, import("../../typification/rest/crm").iBXRestParamCrmCurrencyId | undefined>;
+    /**
+     * Возвращает список валют с локализацией для текущего языка портала.
+     *
+     * @param param Необязательный порядок сортировки.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-list.html
+     */
+    list(param?: iBXRestParamCrmCurrencyList): import("../../services/navvy").NavvySimple<iBXRestCrmCurrencyHttp[], iBXRestCrmCurrency[], iBXRestParamCrmCurrencyList | undefined>;
+    /**
+     * Удаляет валюту.
+     *
+     * @param param Символьный идентификатор удаляемой валюты.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-delete.html
+     */
+    delete(param: iBXRestParamCrmCurrencyDelete): import("../../services/navvy").NavvySimple<boolean, boolean, import("../../typification/rest/crm").iBXRestParamCrmCurrencyId | undefined>;
+    /**
+     * Возвращает описание полей валюты.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-fields.html
+     */
+    fields(): import("../../services/navvy").NavvySimple<iBXRestCrmCurrencyFields, iBXRestCrmCurrencyFields, undefined>;
+}

package/request-navvy/crm.d.ts

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

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

@@ -0,0 +1,146 @@
+import { iBXRestYesNo } from '../base/yes-no';
+import { iBXRestCrmFieldDescription } from './enum';
+/** Направление сортировки списка валют. */
+export type iBXRestCrmCurrencySortDirection = 'ASC' | 'DESC' | 'asc' | 'desc';
+/** Параметры локализации валюты, передаваемые в Bitrix24. */
+export interface iBXRestCrmCurrencyLocalizationFields {
+    /** Число десятичных знаков дробной части. */
+    DECIMALS: number;
+    /** Символ десятичного разделителя. */
+    DEC_POINT?: string;
+    /** Шаблон отображения суммы и знака валюты. */
+    FORMAT_STRING?: string;
+    /** Полное название валюты на выбранном языке. */
+    FULL_NAME?: string;
+    /** Скрывать ли незначащие нули. */
+    HIDE_ZERO?: iBXRestYesNo;
+    /** Пользовательский разделитель разрядов. */
+    THOUSANDS_SEP?: string;
+    /** Код стандартного разделителя разрядов. */
+    THOUSANDS_VARIANT?: string;
+}
+/** Поля новой валюты. */
+export interface iBXRestCrmCurrencyAddFields {
+    /** Символьный идентификатор валюты по ISO 4217, например `RUB`. */
+    CURRENCY: string;
+    /** Является ли валюта базовой. По умолчанию `N`. */
+    BASE?: iBXRestYesNo;
+    /** Номинал валюты, обычно 1 или число, кратное 10. */
+    AMOUNT_CNT: number;
+    /** Курс по отношению к базовой валюте. */
+    AMOUNT: number;
+    /** Положение в списке валют. По умолчанию 100. */
+    SORT?: number;
+    /** Локализации, сгруппированные по идентификатору языка. */
+    LANG?: Record<string, iBXRestCrmCurrencyLocalizationFields>;
+}
+/** Изменяемые поля существующей валюты. */
+export type iBXRestCrmCurrencyUpdateFields = Partial<Omit<iBXRestCrmCurrencyAddFields, 'CURRENCY'>>;
+/** Параметры метода `crm.currency.add`. */
+export interface iBXRestParamCrmCurrencyAdd {
+    /** Значения полей новой валюты. */
+    fields: iBXRestCrmCurrencyAddFields;
+}
+/** Параметры метода `crm.currency.update`. */
+export interface iBXRestParamCrmCurrencyUpdate {
+    /** Символьный идентификатор обновляемой валюты по ISO 4217. */
+    ID: string;
+    /** Изменяемые значения полей валюты. */
+    fields: iBXRestCrmCurrencyUpdateFields;
+}
+/** Параметры методов, принимающих символьный идентификатор валюты. */
+export interface iBXRestParamCrmCurrencyId {
+    /** Символьный идентификатор валюты по ISO 4217. */
+    id: string;
+}
+/** Параметры метода `crm.currency.get`. */
+export type iBXRestParamCrmCurrencyGet = iBXRestParamCrmCurrencyId;
+/** Параметры метода `crm.currency.delete`. */
+export type iBXRestParamCrmCurrencyDelete = iBXRestParamCrmCurrencyId;
+/** Параметры метода `crm.currency.base.set`. */
+export type iBXRestParamCrmCurrencyBaseSet = iBXRestParamCrmCurrencyId;
+/** Поля, по которым можно сортировать список валют. */
+export type iBXRestCrmCurrencySortField = 'CURRENCY' | 'AMOUNT_CNT' | 'AMOUNT' | 'SORT' | 'BASE' | 'FULL_NAME' | 'LID' | 'DATE_UPDATE' | Lowercase<'CURRENCY' | 'AMOUNT_CNT' | 'AMOUNT' | 'SORT' | 'BASE' | 'FULL_NAME' | 'LID' | 'DATE_UPDATE'>;
+/** Параметры метода `crm.currency.list`. */
+export interface iBXRestParamCrmCurrencyList {
+    /** Порядок сортировки по полям валюты. */
+    order?: Partial<Record<iBXRestCrmCurrencySortField, iBXRestCrmCurrencySortDirection>>;
+}
+/** Локализация валюты в локальном формате библиотеки. */
+export interface iBXRestCrmCurrencyLocalization {
+    FORMAT_STRING?: string;
+    FULL_NAME?: string;
+    DEC_POINT?: string;
+    THOUSANDS_SEP?: string | null;
+    DECIMALS: number;
+    THOUSANDS_VARIANT?: string;
+    HIDE_ZERO?: boolean;
+}
+/** Локализация валюты в формате ответа Bitrix24. */
+export interface iBXRestCrmCurrencyLocalizationHttp {
+    FORMAT_STRING?: string;
+    FULL_NAME?: string;
+    DEC_POINT?: string;
+    THOUSANDS_SEP?: string | null;
+    DECIMALS: string;
+    THOUSANDS_VARIANT?: string;
+    HIDE_ZERO?: iBXRestYesNo;
+}
+interface iBXRestCrmCurrencyBase {
+    /** Символьный идентификатор валюты по ISO 4217. */
+    CURRENCY: string;
+    /** Название валюты на текущем языке портала. */
+    FULL_NAME: string;
+    /** Идентификатор текущего языка портала. */
+    LID: string;
+    /** Шаблон отображения суммы и знака валюты. */
+    FORMAT_STRING: string;
+    /** Символ десятичного разделителя. */
+    DEC_POINT: string;
+    /** Разделитель разрядов. */
+    THOUSANDS_SEP: string | null;
+}
+/** Валюта в локальном формате библиотеки. */
+export interface iBXRestCrmCurrency extends iBXRestCrmCurrencyBase {
+    /** Номинал валюты. */
+    AMOUNT_CNT: number;
+    /** Курс по отношению к базовой валюте. */
+    AMOUNT: number;
+    /** Положение в списке валют. */
+    SORT: number;
+    /** Является ли валюта базовой. */
+    BASE: boolean;
+    /** Число десятичных знаков дробной части. */
+    DECIMALS: number;
+    /** Дата последнего изменения валюты. */
+    DATE_UPDATE: Date;
+    /** Локализации, сгруппированные по идентификатору языка. */
+    LANG?: Record<string, iBXRestCrmCurrencyLocalization>;
+}
+/** Валюта в формате ответа Bitrix24. */
+export interface iBXRestCrmCurrencyHttp extends iBXRestCrmCurrencyBase {
+    AMOUNT_CNT: string;
+    AMOUNT: string;
+    SORT: string;
+    BASE: iBXRestYesNo;
+    DECIMALS: string;
+    DATE_UPDATE: string;
+    LANG?: Record<string, iBXRestCrmCurrencyLocalizationHttp>;
+}
+/** Описание полей валюты, возвращаемое методом `crm.currency.fields`. */
+export interface iBXRestCrmCurrencyFields {
+    CURRENCY: iBXRestCrmFieldDescription;
+    AMOUNT_CNT: iBXRestCrmFieldDescription;
+    AMOUNT: iBXRestCrmFieldDescription;
+    BASE: iBXRestCrmFieldDescription;
+    SORT: iBXRestCrmFieldDescription;
+    DATE_UPDATE: iBXRestCrmFieldDescription;
+    LID: iBXRestCrmFieldDescription;
+    FORMAT_STRING: iBXRestCrmFieldDescription;
+    FULL_NAME: iBXRestCrmFieldDescription;
+    DEC_POINT: iBXRestCrmFieldDescription;
+    THOUSANDS_SEP: iBXRestCrmFieldDescription;
+    DECIMALS: iBXRestCrmFieldDescription;
+    LANG: iBXRestCrmFieldDescription;
+}
+export {};

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

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