bx-rest 0.10.1 → 0.10.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,8 @@
1
+ import { iBXRestCrmCurrency, iBXRestCrmCurrencyHttp } from '../../typification/rest/crm';
2
+ export declare class BXRestMapCrmCurrency {
3
+ /** Преобразует список валют из формата Bitrix24 в локальный формат библиотеки. */
4
+ static list(value: iBXRestCrmCurrencyHttp[] | undefined): iBXRestCrmCurrency[] | undefined;
5
+ /** Преобразует валюту из формата Bitrix24 в локальный формат библиотеки. */
6
+ static get(value: iBXRestCrmCurrencyHttp | undefined): iBXRestCrmCurrency | undefined;
7
+ private static localizations;
8
+ }
@@ -4,3 +4,5 @@ export * from './contact';
4
4
  export * from './company';
5
5
  export * from './quote';
6
6
  export * from './automatedsolution';
7
+ export * from './currency';
8
+ export * from './status';
@@ -0,0 +1,9 @@
1
+ import { iBXRestCrmStatus, iBXRestCrmStatusEntityType, iBXRestCrmStatusEntityTypeHttp, iBXRestCrmStatusHttp } from '../../typification/rest/crm';
2
+ export declare class BXRestMapCrmStatus {
3
+ /** Преобразует список элементов справочника из формата Bitrix24 в локальный формат. */
4
+ static list(value: iBXRestCrmStatusHttp[] | undefined): iBXRestCrmStatus[] | undefined;
5
+ /** Преобразует элемент справочника из формата Bitrix24 в локальный формат. */
6
+ static get(value: iBXRestCrmStatusHttp | undefined): iBXRestCrmStatus | undefined;
7
+ /** Нормализует идентификаторы воронок в описаниях типов справочников. */
8
+ static entityTypes(value: iBXRestCrmStatusEntityTypeHttp[] | undefined): iBXRestCrmStatusEntityType[] | undefined;
9
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bx-rest",
3
- "version": "0.10.1",
3
+ "version": "0.10.3",
4
4
  "description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
5
5
  "keywords": [
6
6
  "bitrix",
@@ -0,0 +1,20 @@
1
+ import { iBXRestParamCrmCurrencyBaseSet } from '../../../typification/rest/crm';
2
+ /** Методы управления базовой валютой (`crm.currency.base.*`). */
3
+ export declare class BXRestNavvyCrmCurrencyBase {
4
+ private readonly Navvy;
5
+ private readonly url;
6
+ /**
7
+ * Возвращает символьный идентификатор базовой валюты.
8
+ *
9
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-base-get.html
10
+ */
11
+ get(): import("../../../services/navvy").NavvySimple<string, string, undefined>;
12
+ /**
13
+ * Устанавливает указанную валюту в качестве базовой.
14
+ * После смены базовой валюты курсы остальных валют необходимо обновить вручную.
15
+ *
16
+ * @param param Символьный идентификатор новой базовой валюты.
17
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-base-set.html
18
+ */
19
+ set(param: iBXRestParamCrmCurrencyBaseSet): import("../../../services/navvy").NavvySimple<boolean, boolean, import("../../../typification/rest/crm").iBXRestParamCrmCurrencyId | undefined>;
20
+ }
@@ -0,0 +1,51 @@
1
+ import { iBXRestCrmCurrency, iBXRestCrmCurrencyFields, iBXRestCrmCurrencyHttp, iBXRestParamCrmCurrencyAdd, iBXRestParamCrmCurrencyDelete, iBXRestParamCrmCurrencyGet, iBXRestParamCrmCurrencyList, iBXRestParamCrmCurrencyUpdate } from '../../typification/rest/crm';
2
+ import { BXRestNavvyCrmCurrencyBase } from './currency/base';
3
+ export * from './currency/base';
4
+ /** Навигатор REST-методов валют CRM (`crm.currency.*`). */
5
+ export declare class BXRestNavvyCrmCurrency {
6
+ private readonly Navvy;
7
+ private readonly url;
8
+ /** Базовая валюта (`crm.currency.base.*`). */
9
+ readonly base: BXRestNavvyCrmCurrencyBase;
10
+ /**
11
+ * Создает новую валюту.
12
+ *
13
+ * @param param Поля новой валюты, включая код ISO 4217, номинал и курс.
14
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-add.html
15
+ */
16
+ add(param: iBXRestParamCrmCurrencyAdd): import("../../services/navvy").NavvySimple<string, string, iBXRestParamCrmCurrencyAdd | undefined>;
17
+ /**
18
+ * Обновляет существующую валюту.
19
+ *
20
+ * @param param Идентификатор валюты и изменяемые поля.
21
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-update.html
22
+ */
23
+ update(param: iBXRestParamCrmCurrencyUpdate): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmCurrencyUpdate | undefined>;
24
+ /**
25
+ * Возвращает валюту по символьному идентификатору.
26
+ *
27
+ * @param param Символьный идентификатор валюты по ISO 4217.
28
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-get.html
29
+ */
30
+ get(param: iBXRestParamCrmCurrencyGet): import("../../services/navvy").NavvySimple<iBXRestCrmCurrencyHttp, iBXRestCrmCurrency, import("../../typification/rest/crm").iBXRestParamCrmCurrencyId | undefined>;
31
+ /**
32
+ * Возвращает список валют с локализацией для текущего языка портала.
33
+ *
34
+ * @param param Необязательный порядок сортировки.
35
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-list.html
36
+ */
37
+ list(param?: iBXRestParamCrmCurrencyList): import("../../services/navvy").NavvySimple<iBXRestCrmCurrencyHttp[], iBXRestCrmCurrency[], iBXRestParamCrmCurrencyList | undefined>;
38
+ /**
39
+ * Удаляет валюту.
40
+ *
41
+ * @param param Символьный идентификатор удаляемой валюты.
42
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-delete.html
43
+ */
44
+ delete(param: iBXRestParamCrmCurrencyDelete): import("../../services/navvy").NavvySimple<boolean, boolean, import("../../typification/rest/crm").iBXRestParamCrmCurrencyId | undefined>;
45
+ /**
46
+ * Возвращает описание полей валюты.
47
+ *
48
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-fields.html
49
+ */
50
+ fields(): import("../../services/navvy").NavvySimple<iBXRestCrmCurrencyFields, iBXRestCrmCurrencyFields, undefined>;
51
+ }
@@ -0,0 +1,20 @@
1
+ import { iBXRestCrmStatusEntityItem, iBXRestCrmStatusEntityType, iBXRestCrmStatusEntityTypeHttp, iBXRestParamCrmStatusEntityItems } from '../../../typification/rest/crm';
2
+ /** Навигатор методов описания типов справочников CRM (`crm.status.entity.*`). */
3
+ export declare class BXRestNavvyCrmStatusEntity {
4
+ private readonly Navvy;
5
+ private readonly url;
6
+ /**
7
+ * Возвращает все элементы указанного справочника с сортировкой по полю `SORT`.
8
+ *
9
+ * @param param Символьный идентификатор справочника в поле `entityId`.
10
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-entity-items.html
11
+ */
12
+ items(param: iBXRestParamCrmStatusEntityItems): import("../../../services/navvy").NavvySimple<iBXRestCrmStatusEntityItem[], iBXRestCrmStatusEntityItem[], iBXRestParamCrmStatusEntityItems | undefined>;
13
+ /**
14
+ * Возвращает все поддерживаемые типы справочников и их символьные идентификаторы.
15
+ * Для справочников стадий ответ также содержит сведения о воронке и семантике.
16
+ *
17
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-entity-types.html
18
+ */
19
+ types(): import("../../../services/navvy").NavvySimple<iBXRestCrmStatusEntityTypeHttp[], iBXRestCrmStatusEntityType[], undefined>;
20
+ }
@@ -0,0 +1,54 @@
1
+ import { iBXRestCrmStatus, iBXRestCrmStatusFields, iBXRestCrmStatusHttp, iBXRestParamCrmStatusAdd, iBXRestParamCrmStatusDelete, iBXRestParamCrmStatusGet, iBXRestParamCrmStatusList, iBXRestParamCrmStatusUpdate } from '../../typification/rest/crm';
2
+ import { BXRestNavvyCrmStatusEntity } from './status/entity';
3
+ export * from './status/entity';
4
+ /** Навигатор REST-методов справочников CRM (`crm.status.*`). */
5
+ export declare class BXRestNavvyCrmStatus {
6
+ private readonly Navvy;
7
+ private readonly url;
8
+ /** Типы справочников и получение их элементов (`crm.status.entity.*`). */
9
+ readonly entity: BXRestNavvyCrmStatusEntity;
10
+ /**
11
+ * Создает новый элемент в указанном справочнике CRM.
12
+ * Для стадий пользовательских воронок Bitrix24 автоматически добавляет к `STATUS_ID` префикс воронки.
13
+ *
14
+ * @param param Тип справочника и поля нового элемента.
15
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-add.html
16
+ */
17
+ add(param: iBXRestParamCrmStatusAdd): import("../../services/navvy").NavvySimple<number, number, iBXRestParamCrmStatusAdd | undefined>;
18
+ /**
19
+ * Обновляет название, сортировку или цвет существующего элемента справочника.
20
+ *
21
+ * @param param Идентификатор элемента и изменяемые поля.
22
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-update.html
23
+ */
24
+ update(param: iBXRestParamCrmStatusUpdate): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmStatusUpdate | undefined>;
25
+ /**
26
+ * Возвращает элемент справочника по числовому идентификатору.
27
+ *
28
+ * @param param Идентификатор элемента справочника.
29
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-get.html
30
+ */
31
+ get(param: iBXRestParamCrmStatusGet): import("../../services/navvy").NavvySimple<iBXRestCrmStatusHttp, iBXRestCrmStatus, import("../../typification/rest/crm").iBXRestParamCrmStatusId | undefined>;
32
+ /**
33
+ * Возвращает список элементов справочников по фильтру с заданной сортировкой.
34
+ * Навигатор поддерживает получение всех страниц результата через `resAll()`.
35
+ *
36
+ * @param param Фильтр, сортировка и начальная позиция страницы.
37
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-list.html
38
+ */
39
+ list(param?: iBXRestParamCrmStatusList): import("../../services/navvy").NavvyPag<iBXRestCrmStatusHttp, iBXRestCrmStatus, iBXRestParamCrmStatusList>;
40
+ /**
41
+ * Удаляет элемент справочника.
42
+ * Для системного элемента передайте `params.FORCED: 'Y'`.
43
+ *
44
+ * @param param Идентификатор элемента и необязательный флаг принудительного удаления.
45
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-delete.html
46
+ */
47
+ delete(param: iBXRestParamCrmStatusDelete): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmStatusDelete | undefined>;
48
+ /**
49
+ * Возвращает описание полей элементов справочников CRM.
50
+ *
51
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/status/crm-status-fields.html
52
+ */
53
+ fields(): import("../../services/navvy").NavvySimple<iBXRestCrmStatusFields, iBXRestCrmStatusFields, undefined>;
54
+ }
@@ -8,7 +8,13 @@ import { BXRestNavvyCrmMultifield } from './crm/multifield';
8
8
  import { BXRestNavvyCrmAutomation } from './crm/automation/index';
9
9
  import { BXRestNavvyCrmAutomatedSolution } from './crm/automatedsolution';
10
10
  import { BXRestNavvyCrmDocumentGenerator } from './crm/documentgenerator/index';
11
+ import { BXRestNavvyCrmCurrency } from './crm/currency';
12
+ import { BXRestNavvyCrmStatus } from './crm/status';
11
13
  export declare class BXRestNavvyCrm {
14
+ /** Справочники CRM (`crm.status.*`). */
15
+ readonly status: BXRestNavvyCrmStatus;
16
+ /** Валюты CRM (`crm.currency.*`). */
17
+ readonly currency: BXRestNavvyCrmCurrency;
12
18
  /** Генератор документов CRM (`crm.documentgenerator.*`). */
13
19
  readonly documentGenerator: BXRestNavvyCrmDocumentGenerator;
14
20
  /** Цифровые рабочие места (`crm.automatedsolution.*`). */
@@ -0,0 +1,146 @@
1
+ import { iBXRestYesNo } from '../base/yes-no';
2
+ import { iBXRestCrmFieldDescription } from './enum';
3
+ /** Направление сортировки списка валют. */
4
+ export type iBXRestCrmCurrencySortDirection = 'ASC' | 'DESC' | 'asc' | 'desc';
5
+ /** Параметры локализации валюты, передаваемые в Bitrix24. */
6
+ export interface iBXRestCrmCurrencyLocalizationFields {
7
+ /** Число десятичных знаков дробной части. */
8
+ DECIMALS: number;
9
+ /** Символ десятичного разделителя. */
10
+ DEC_POINT?: string;
11
+ /** Шаблон отображения суммы и знака валюты. */
12
+ FORMAT_STRING?: string;
13
+ /** Полное название валюты на выбранном языке. */
14
+ FULL_NAME?: string;
15
+ /** Скрывать ли незначащие нули. */
16
+ HIDE_ZERO?: iBXRestYesNo;
17
+ /** Пользовательский разделитель разрядов. */
18
+ THOUSANDS_SEP?: string;
19
+ /** Код стандартного разделителя разрядов. */
20
+ THOUSANDS_VARIANT?: string;
21
+ }
22
+ /** Поля новой валюты. */
23
+ export interface iBXRestCrmCurrencyAddFields {
24
+ /** Символьный идентификатор валюты по ISO 4217, например `RUB`. */
25
+ CURRENCY: string;
26
+ /** Является ли валюта базовой. По умолчанию `N`. */
27
+ BASE?: iBXRestYesNo;
28
+ /** Номинал валюты, обычно 1 или число, кратное 10. */
29
+ AMOUNT_CNT: number;
30
+ /** Курс по отношению к базовой валюте. */
31
+ AMOUNT: number;
32
+ /** Положение в списке валют. По умолчанию 100. */
33
+ SORT?: number;
34
+ /** Локализации, сгруппированные по идентификатору языка. */
35
+ LANG?: Record<string, iBXRestCrmCurrencyLocalizationFields>;
36
+ }
37
+ /** Изменяемые поля существующей валюты. */
38
+ export type iBXRestCrmCurrencyUpdateFields = Partial<Omit<iBXRestCrmCurrencyAddFields, 'CURRENCY'>>;
39
+ /** Параметры метода `crm.currency.add`. */
40
+ export interface iBXRestParamCrmCurrencyAdd {
41
+ /** Значения полей новой валюты. */
42
+ fields: iBXRestCrmCurrencyAddFields;
43
+ }
44
+ /** Параметры метода `crm.currency.update`. */
45
+ export interface iBXRestParamCrmCurrencyUpdate {
46
+ /** Символьный идентификатор обновляемой валюты по ISO 4217. */
47
+ ID: string;
48
+ /** Изменяемые значения полей валюты. */
49
+ fields: iBXRestCrmCurrencyUpdateFields;
50
+ }
51
+ /** Параметры методов, принимающих символьный идентификатор валюты. */
52
+ export interface iBXRestParamCrmCurrencyId {
53
+ /** Символьный идентификатор валюты по ISO 4217. */
54
+ id: string;
55
+ }
56
+ /** Параметры метода `crm.currency.get`. */
57
+ export type iBXRestParamCrmCurrencyGet = iBXRestParamCrmCurrencyId;
58
+ /** Параметры метода `crm.currency.delete`. */
59
+ export type iBXRestParamCrmCurrencyDelete = iBXRestParamCrmCurrencyId;
60
+ /** Параметры метода `crm.currency.base.set`. */
61
+ export type iBXRestParamCrmCurrencyBaseSet = iBXRestParamCrmCurrencyId;
62
+ /** Поля, по которым можно сортировать список валют. */
63
+ 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'>;
64
+ /** Параметры метода `crm.currency.list`. */
65
+ export interface iBXRestParamCrmCurrencyList {
66
+ /** Порядок сортировки по полям валюты. */
67
+ order?: Partial<Record<iBXRestCrmCurrencySortField, iBXRestCrmCurrencySortDirection>>;
68
+ }
69
+ /** Локализация валюты в локальном формате библиотеки. */
70
+ export interface iBXRestCrmCurrencyLocalization {
71
+ FORMAT_STRING?: string;
72
+ FULL_NAME?: string;
73
+ DEC_POINT?: string;
74
+ THOUSANDS_SEP?: string | null;
75
+ DECIMALS: number;
76
+ THOUSANDS_VARIANT?: string;
77
+ HIDE_ZERO?: boolean;
78
+ }
79
+ /** Локализация валюты в формате ответа Bitrix24. */
80
+ export interface iBXRestCrmCurrencyLocalizationHttp {
81
+ FORMAT_STRING?: string;
82
+ FULL_NAME?: string;
83
+ DEC_POINT?: string;
84
+ THOUSANDS_SEP?: string | null;
85
+ DECIMALS: string;
86
+ THOUSANDS_VARIANT?: string;
87
+ HIDE_ZERO?: iBXRestYesNo;
88
+ }
89
+ interface iBXRestCrmCurrencyBase {
90
+ /** Символьный идентификатор валюты по ISO 4217. */
91
+ CURRENCY: string;
92
+ /** Название валюты на текущем языке портала. */
93
+ FULL_NAME: string;
94
+ /** Идентификатор текущего языка портала. */
95
+ LID: string;
96
+ /** Шаблон отображения суммы и знака валюты. */
97
+ FORMAT_STRING: string;
98
+ /** Символ десятичного разделителя. */
99
+ DEC_POINT: string;
100
+ /** Разделитель разрядов. */
101
+ THOUSANDS_SEP: string | null;
102
+ }
103
+ /** Валюта в локальном формате библиотеки. */
104
+ export interface iBXRestCrmCurrency extends iBXRestCrmCurrencyBase {
105
+ /** Номинал валюты. */
106
+ AMOUNT_CNT: number;
107
+ /** Курс по отношению к базовой валюте. */
108
+ AMOUNT: number;
109
+ /** Положение в списке валют. */
110
+ SORT: number;
111
+ /** Является ли валюта базовой. */
112
+ BASE: boolean;
113
+ /** Число десятичных знаков дробной части. */
114
+ DECIMALS: number;
115
+ /** Дата последнего изменения валюты. */
116
+ DATE_UPDATE: Date;
117
+ /** Локализации, сгруппированные по идентификатору языка. */
118
+ LANG?: Record<string, iBXRestCrmCurrencyLocalization>;
119
+ }
120
+ /** Валюта в формате ответа Bitrix24. */
121
+ export interface iBXRestCrmCurrencyHttp extends iBXRestCrmCurrencyBase {
122
+ AMOUNT_CNT: string;
123
+ AMOUNT: string;
124
+ SORT: string;
125
+ BASE: iBXRestYesNo;
126
+ DECIMALS: string;
127
+ DATE_UPDATE: string;
128
+ LANG?: Record<string, iBXRestCrmCurrencyLocalizationHttp>;
129
+ }
130
+ /** Описание полей валюты, возвращаемое методом `crm.currency.fields`. */
131
+ export interface iBXRestCrmCurrencyFields {
132
+ CURRENCY: iBXRestCrmFieldDescription;
133
+ AMOUNT_CNT: iBXRestCrmFieldDescription;
134
+ AMOUNT: iBXRestCrmFieldDescription;
135
+ BASE: iBXRestCrmFieldDescription;
136
+ SORT: iBXRestCrmFieldDescription;
137
+ DATE_UPDATE: iBXRestCrmFieldDescription;
138
+ LID: iBXRestCrmFieldDescription;
139
+ FORMAT_STRING: iBXRestCrmFieldDescription;
140
+ FULL_NAME: iBXRestCrmFieldDescription;
141
+ DEC_POINT: iBXRestCrmFieldDescription;
142
+ THOUSANDS_SEP: iBXRestCrmFieldDescription;
143
+ DECIMALS: iBXRestCrmFieldDescription;
144
+ LANG: iBXRestCrmFieldDescription;
145
+ }
146
+ export {};
@@ -8,3 +8,5 @@ export * from './multifield';
8
8
  export * from './automation';
9
9
  export * from './automatedsolution';
10
10
  export * from './documentgenerator';
11
+ export * from './currency';
12
+ export * from './status';
@@ -0,0 +1,167 @@
1
+ import { iBXRestPagination } from '../base/api-pagination-bx';
2
+ import { iBXRestParamSort } from '../base/sort';
3
+ import { iBXRestYesNo } from '../base/yes-no';
4
+ import { iBXRestCrmFieldDescription } from './enum';
5
+ /** Группа стадии: успех, провал или стадия в работе. */
6
+ export type iBXRestCrmStatusSemantics = 'S' | 'F' | '';
7
+ /** Поля нового элемента справочника CRM. */
8
+ export interface iBXRestCrmStatusAddFields {
9
+ /** Символьный идентификатор справочника, например `DEAL_STAGE` или `SOURCE`. */
10
+ ENTITY_ID: string;
11
+ /** Уникальный в рамках справочника код значения. */
12
+ STATUS_ID: string;
13
+ /** Отображаемое название значения. */
14
+ NAME: string;
15
+ /** Позиция значения в справочнике. По умолчанию 10. */
16
+ SORT?: number;
17
+ /** Цвет стадии в формате hex, например `#39A8EF`. */
18
+ COLOR?: string;
19
+ /** Группа стадии: `S` — успех, `F` — провал, пустая строка — в работе. */
20
+ SEMANTICS?: iBXRestCrmStatusSemantics;
21
+ }
22
+ /** Изменяемые поля элемента справочника CRM. */
23
+ export interface iBXRestCrmStatusUpdateFields {
24
+ /** Новое отображаемое название. */
25
+ NAME?: string;
26
+ /** Новая позиция в справочнике. */
27
+ SORT?: number;
28
+ /** Новый цвет стадии в формате hex. */
29
+ COLOR?: string;
30
+ }
31
+ /** Параметры метода `crm.status.add`. */
32
+ export interface iBXRestParamCrmStatusAdd {
33
+ /** Поля нового элемента справочника. */
34
+ fields: iBXRestCrmStatusAddFields;
35
+ }
36
+ /** Параметры метода `crm.status.update`. */
37
+ export interface iBXRestParamCrmStatusUpdate {
38
+ /** Числовой идентификатор изменяемого элемента. */
39
+ id: number;
40
+ /** Изменяемые поля элемента справочника. */
41
+ fields: iBXRestCrmStatusUpdateFields;
42
+ }
43
+ /** Параметры методов, принимающих идентификатор элемента справочника. */
44
+ export interface iBXRestParamCrmStatusId {
45
+ /** Числовой идентификатор элемента справочника. */
46
+ id: number;
47
+ }
48
+ /** Параметры метода `crm.status.get`. */
49
+ export type iBXRestParamCrmStatusGet = iBXRestParamCrmStatusId;
50
+ /** Параметры метода `crm.status.delete`. */
51
+ export interface iBXRestParamCrmStatusDelete extends iBXRestParamCrmStatusId {
52
+ params?: {
53
+ /** Разрешает удалить системный элемент справочника. По умолчанию `N`. */
54
+ FORCED?: iBXRestYesNo;
55
+ };
56
+ }
57
+ /** Поля элемента справочника, доступные для сортировки и фильтрации. */
58
+ export type iBXRestCrmStatusField = 'ID' | 'ENTITY_ID' | 'STATUS_ID' | 'SORT' | 'NAME' | 'NAME_INIT' | 'SYSTEM' | 'CATEGORY_ID' | 'COLOR' | 'SEMANTICS' | 'EXTRA';
59
+ /** Параметры метода `crm.status.list`. */
60
+ export interface iBXRestParamCrmStatusList extends iBXRestPagination {
61
+ /** Порядок сортировки элементов по полям справочника. */
62
+ order?: Partial<Record<iBXRestCrmStatusField, iBXRestParamSort>>;
63
+ /** Фильтр по полям справочника, включая REST-префиксы операторов. */
64
+ filter?: Record<string, any>;
65
+ }
66
+ /** Параметры метода `crm.status.entity.items`. */
67
+ export interface iBXRestParamCrmStatusEntityItems {
68
+ /** Символьный идентификатор справочника, например `DEAL_STAGE` или `SOURCE`. */
69
+ entityId: string;
70
+ }
71
+ /** Дополнительные данные элемента справочника. */
72
+ export interface iBXRestCrmStatusExtra extends Record<string, any> {
73
+ /** Семантика стадии в человекочитаемом формате. */
74
+ SEMANTICS?: string;
75
+ /** Цвет стадии в формате hex. */
76
+ COLOR?: string;
77
+ }
78
+ interface iBXRestCrmStatusBase {
79
+ /** Символьный идентификатор справочника. */
80
+ ENTITY_ID: string;
81
+ /** Код значения, используемый в полях элементов CRM. */
82
+ STATUS_ID: string;
83
+ /** Отображаемое название. */
84
+ NAME: string;
85
+ /** Исходное системное название. */
86
+ NAME_INIT: string;
87
+ /** Цвет стадии в формате hex. */
88
+ COLOR: string;
89
+ /** Группа стадии. */
90
+ SEMANTICS: iBXRestCrmStatusSemantics | null;
91
+ /** Дополнительные данные элемента. */
92
+ EXTRA?: iBXRestCrmStatusExtra;
93
+ }
94
+ /** Элемент справочника CRM в локальном формате библиотеки. */
95
+ export interface iBXRestCrmStatus extends iBXRestCrmStatusBase {
96
+ /** Числовой идентификатор элемента. */
97
+ ID: number;
98
+ /** Позиция элемента в справочнике. */
99
+ SORT: number;
100
+ /** Является ли элемент системным. */
101
+ SYSTEM: boolean;
102
+ /** Идентификатор воронки для статуса-стадии. */
103
+ CATEGORY_ID: number | null;
104
+ }
105
+ /** Элемент справочника CRM в формате ответа Bitrix24. */
106
+ export interface iBXRestCrmStatusHttp extends iBXRestCrmStatusBase {
107
+ ID: string;
108
+ SORT: string;
109
+ SYSTEM: iBXRestYesNo;
110
+ CATEGORY_ID: string | null;
111
+ }
112
+ /** Краткое представление элемента, возвращаемое `crm.status.entity.items`. */
113
+ export interface iBXRestCrmStatusEntityItem {
114
+ /** Отображаемое название. */
115
+ NAME: string;
116
+ /** Позиция элемента в справочнике. */
117
+ SORT: number;
118
+ /** Код значения, используемый в полях элементов CRM. */
119
+ STATUS_ID: string;
120
+ }
121
+ /** Семантические границы справочника стадий. */
122
+ export interface iBXRestCrmStatusSemanticInfo {
123
+ /** Код начальной стадии. */
124
+ START_FIELD: string;
125
+ /** Код успешной финальной стадии. */
126
+ FINAL_SUCCESS_FIELD: string;
127
+ /** Код неуспешной финальной стадии. */
128
+ FINAL_UNSUCCESS_FIELD: string;
129
+ /** Позиция финальной стадии. */
130
+ FINAL_SORT: number;
131
+ }
132
+ interface iBXRestCrmStatusEntityTypeBase {
133
+ /** Символьный идентификатор справочника для параметра `ENTITY_ID`. */
134
+ ID: string;
135
+ /** Отображаемое название справочника. */
136
+ NAME: string;
137
+ /** Тип объекта CRM, к которому относится справочник стадий. */
138
+ ENTITY_TYPE_ID?: number;
139
+ /** Семантические границы стадий; некоторые типы API возвращают пустой массив. */
140
+ SEMANTIC_INFO?: iBXRestCrmStatusSemanticInfo | [];
141
+ /** Префикс кода стадии воронки. */
142
+ PREFIX?: string;
143
+ /** Область применения поля, соответствующая воронке. */
144
+ FIELD_ATTRIBUTE_SCOPE?: string;
145
+ /** Активен ли тип справочника. */
146
+ IS_ENABLED?: boolean;
147
+ /** Идентификатор родительского справочника. */
148
+ PARENT_ID?: string;
149
+ /** Название воронки. */
150
+ CATEGORY_NAME?: string;
151
+ /** Позиция воронки. */
152
+ CATEGORY_SORT?: number;
153
+ /** Является ли воронка воронкой по умолчанию. */
154
+ IS_DEFAULT_CATEGORY?: boolean;
155
+ }
156
+ /** Описание типа справочника в локальном формате библиотеки. */
157
+ export interface iBXRestCrmStatusEntityType extends iBXRestCrmStatusEntityTypeBase {
158
+ /** Идентификатор воронки. */
159
+ CATEGORY_ID?: number;
160
+ }
161
+ /** Описание типа справочника в формате ответа Bitrix24. */
162
+ export interface iBXRestCrmStatusEntityTypeHttp extends iBXRestCrmStatusEntityTypeBase {
163
+ CATEGORY_ID?: number | string;
164
+ }
165
+ /** Описание полей, возвращаемое методом `crm.status.fields`. */
166
+ export type iBXRestCrmStatusFields = Record<iBXRestCrmStatusField, iBXRestCrmFieldDescription>;
167
+ export {};