bx-rest 0.10.4 → 0.10.6

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.
Files changed (35) hide show
  1. package/consts/part-name-methods.d.ts +10 -0
  2. package/esm2022/consts/part-name-methods.mjs +11 -1
  3. package/esm2022/map/crm/calllist.mjs +30 -0
  4. package/esm2022/map/crm/index.mjs +2 -1
  5. package/esm2022/request-navvy/crm/address.mjs +66 -0
  6. package/esm2022/request-navvy/crm/calllist/index.mjs +79 -0
  7. package/esm2022/request-navvy/crm/calllist/items.mjs +24 -0
  8. package/esm2022/request-navvy/crm/requisite/bankdetail.mjs +70 -0
  9. package/esm2022/request-navvy/crm/requisite/index.mjs +89 -0
  10. package/esm2022/request-navvy/crm/requisite/link.mjs +62 -0
  11. package/esm2022/request-navvy/crm/requisite/preset/field.mjs +82 -0
  12. package/esm2022/request-navvy/crm/requisite/preset/index.mjs +83 -0
  13. package/esm2022/request-navvy/crm/requisite/userfield.mjs +63 -0
  14. package/esm2022/request-navvy/crm.mjs +10 -1
  15. package/esm2022/typification/rest/crm/calllist.mjs +2 -0
  16. package/esm2022/typification/rest/crm/index.mjs +3 -1
  17. package/esm2022/typification/rest/crm/requisite.mjs +2 -0
  18. package/fesm2022/bx-rest.mjs +641 -0
  19. package/fesm2022/bx-rest.mjs.map +1 -1
  20. package/map/crm/calllist.d.ts +8 -0
  21. package/map/crm/index.d.ts +1 -0
  22. package/package.json +1 -1
  23. package/request-navvy/crm/address.d.ts +46 -0
  24. package/request-navvy/crm/calllist/index.d.ts +58 -0
  25. package/request-navvy/crm/calllist/items.d.ts +16 -0
  26. package/request-navvy/crm/requisite/bankdetail.d.ts +47 -0
  27. package/request-navvy/crm/requisite/index.d.ts +66 -0
  28. package/request-navvy/crm/requisite/link.d.ts +42 -0
  29. package/request-navvy/crm/requisite/preset/field.d.ts +56 -0
  30. package/request-navvy/crm/requisite/preset/index.d.ts +57 -0
  31. package/request-navvy/crm/requisite/userfield.d.ts +43 -0
  32. package/request-navvy/crm.d.ts +9 -0
  33. package/typification/rest/crm/calllist.d.ts +117 -0
  34. package/typification/rest/crm/index.d.ts +2 -0
  35. package/typification/rest/crm/requisite.d.ts +369 -0
@@ -0,0 +1,8 @@
1
+ import { iBXRestCrmCallList, iBXRestCrmCallListHttp, iBXRestCrmCallListListItem, iBXRestCrmCallListListItemHttp } from '../../typification/rest/crm';
2
+ export declare class BXRestMapCrmCallList {
3
+ /** Преобразует данные списка обзвона из формата Bitrix24 в локальный формат. */
4
+ static get(value: iBXRestCrmCallListHttp | undefined): iBXRestCrmCallList | undefined;
5
+ /** Преобразует список обзвонов с учетом полей, выбранных через `SELECT`. */
6
+ static list(value: iBXRestCrmCallListListItemHttp[] | undefined): iBXRestCrmCallListListItem[] | undefined;
7
+ private static mapItem;
8
+ }
@@ -6,3 +6,4 @@ export * from './quote';
6
6
  export * from './automatedsolution';
7
7
  export * from './currency';
8
8
  export * from './status';
9
+ export * from './calllist';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bx-rest",
3
- "version": "0.10.4",
3
+ "version": "0.10.6",
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,46 @@
1
+ import { iBXRestCrmAddressFields, iBXRestCrmRequisiteFieldsDescription, iBXRestParamCrmAddressAdd, iBXRestParamCrmAddressDelete, iBXRestParamCrmAddressList, iBXRestParamCrmAddressUpdate } from '../../typification/rest/crm';
2
+ /** Адреса CRM (`crm.address.*`). Адреса реквизитов отображаются в карточках компаний и контактов. */
3
+ export declare class BXRestNavvyCrmAddress {
4
+ private readonly Navvy;
5
+ private readonly url;
6
+ /**
7
+ * Добавляет адрес к реквизиту, лиду или поддерживаемому объекту старого режима.
8
+ *
9
+ * Адрес уникален по сочетанию `TYPE_ID`, `ENTITY_TYPE_ID` и `ENTITY_ID`.
10
+ * Типы адресов возвращает `crm.enum.addresstype`, типы объектов — `crm.enum.ownertype`.
11
+ *
12
+ * @param param Составной ключ адреса и его почтовые поля.
13
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-add.html
14
+ */
15
+ add(param: iBXRestParamCrmAddressAdd): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmAddressAdd | undefined>;
16
+ /**
17
+ * Изменяет адрес, найденный по составному ключу в `fields`.
18
+ *
19
+ * Поля `ANCHOR_TYPE_ID` и `ANCHOR_ID` являются служебными и заполняются автоматически.
20
+ *
21
+ * @param param Ключ адреса и изменяемые значения.
22
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-update.html
23
+ */
24
+ update(param: iBXRestParamCrmAddressUpdate): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmAddressUpdate | undefined>;
25
+ /**
26
+ * Возвращает адреса по фильтру с выборкой полей, сортировкой и пагинацией.
27
+ *
28
+ * Для адресов реквизита обычно фильтруют по `ENTITY_TYPE_ID: 8` и идентификатору
29
+ * реквизита в `ENTITY_ID`.
30
+ *
31
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-list.html
32
+ */
33
+ list(param?: iBXRestParamCrmAddressList): import("../../services/navvy").NavvyPag<iBXRestCrmAddressFields, iBXRestCrmAddressFields, iBXRestParamCrmAddressList>;
34
+ /**
35
+ * Удаляет адрес по составному ключу `TYPE_ID`, `ENTITY_TYPE_ID`, `ENTITY_ID`.
36
+ *
37
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-delete.html
38
+ */
39
+ delete(param: iBXRestParamCrmAddressDelete): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmAddressDelete | undefined>;
40
+ /**
41
+ * Возвращает формальное описание полей адреса.
42
+ *
43
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-fields.html
44
+ */
45
+ fields(): import("../../services/navvy").NavvySimple<iBXRestCrmRequisiteFieldsDescription, iBXRestCrmRequisiteFieldsDescription, undefined>;
46
+ }
@@ -0,0 +1,58 @@
1
+ import { iBXRestCrmCallList, iBXRestCrmCallListHttp, iBXRestCrmCallListStatus, iBXRestParamCrmCallListAdd, iBXRestParamCrmCallListGet, iBXRestParamCrmCallListList, iBXRestParamCrmCallListUpdate } from '../../../typification/rest/crm';
2
+ import { BXRestNavvyCrmCallListItems } from './items';
3
+ export * from './items';
4
+ /** Навигатор REST-методов списков обзвона (`crm.calllist.*`). */
5
+ export declare class BXRestNavvyCrmCallList {
6
+ private readonly Navvy;
7
+ private readonly url;
8
+ /** Участники списка обзвона (`crm.calllist.items.*`). */
9
+ readonly items: BXRestNavvyCrmCallListItems;
10
+ /**
11
+ * Создает список обзвона из контактов или компаний.
12
+ *
13
+ * В одном списке могут находиться объекты только одного типа, заданного в `ENTITY_TYPE`.
14
+ *
15
+ * @param param Тип объектов, их идентификаторы и необязательная CRM-форма.
16
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-add.html
17
+ */
18
+ add(param: iBXRestParamCrmCallListAdd): import("../../../services/navvy").NavvySimple<number, number, iBXRestParamCrmCallListAdd | undefined>;
19
+ /**
20
+ * Возвращает данные списка обзвона по идентификатору без списка участников.
21
+ *
22
+ * Участников можно получить через `items.get()`.
23
+ *
24
+ * @param param Идентификатор списка обзвона.
25
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-get.html
26
+ */
27
+ get(param: iBXRestParamCrmCallListGet): import("../../../services/navvy").NavvySimple<iBXRestCrmCallListHttp, iBXRestCrmCallList, iBXRestParamCrmCallListGet | undefined>;
28
+ /**
29
+ * Возвращает списки обзвона с выборкой полей, фильтрацией и сортировкой.
30
+ *
31
+ * Набор полей каждого элемента результата зависит от `SELECT`.
32
+ *
33
+ * @param param Выбираемые поля, фильтр и порядок сортировки.
34
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-list.html
35
+ */
36
+ list(param?: iBXRestParamCrmCallListList): import("../../../services/navvy").NavvySimple<Partial<iBXRestCrmCallListHttp>[], Partial<iBXRestCrmCallList>[], iBXRestParamCrmCallListList | undefined>;
37
+ /**
38
+ * Возвращает справочник статусов обзвона.
39
+ *
40
+ * Значение `STATUS_ID` можно передать в `items.get({ FILTER: { STATUS } })`.
41
+ * Создание, изменение и удаление статусов выполняется методами `crm.status.*`
42
+ * со значением `ENTITY_ID: 'CALL_LIST'`.
43
+ *
44
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-statuslist.html
45
+ */
46
+ statusList(): import("../../../services/navvy").NavvySimple<iBXRestCrmCallListStatus[], iBXRestCrmCallListStatus[], undefined>;
47
+ /**
48
+ * Заменяет состав существующего списка обзвона и обновляет связанную CRM-форму.
49
+ *
50
+ * `ENTITIES` перезаписывается целиком: чтобы добавить участников, передайте и текущие,
51
+ * и новые идентификаторы; чтобы удалить — только те, которые должны остаться.
52
+ * Если `WEBFORM_ID` не передан, ранее установленная CRM-форма будет очищена.
53
+ *
54
+ * @param param Идентификатор списка и его новый полный состав.
55
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-update.html
56
+ */
57
+ update(param: iBXRestParamCrmCallListUpdate): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmCallListUpdate | undefined>;
58
+ }
@@ -0,0 +1,16 @@
1
+ import { iBXRestCrmCallListItem, iBXRestParamCrmCallListItemsGet } from '../../../typification/rest/crm';
2
+ /** Участники списка обзвона (`crm.calllist.items.*`). */
3
+ export declare class BXRestNavvyCrmCallListItems {
4
+ private readonly Navvy;
5
+ private readonly url;
6
+ /**
7
+ * Возвращает контакты или компании из списка обзвона вместе с их текущими статусами.
8
+ *
9
+ * Для фильтрации передайте `FILTER.STATUS`; доступные коды возвращает
10
+ * `crm.calllist.statuslist`.
11
+ *
12
+ * @param param Идентификатор списка и необязательный фильтр по статусу.
13
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-items-get.html
14
+ */
15
+ get(param: iBXRestParamCrmCallListItemsGet): import("../../../services/navvy").NavvySimple<iBXRestCrmCallListItem[], iBXRestCrmCallListItem[], iBXRestParamCrmCallListItemsGet | undefined>;
16
+ }
@@ -0,0 +1,47 @@
1
+ import { iBXRestCrmRequisiteBankDetail, iBXRestCrmRequisiteFieldsDescription, iBXRestParamCrmRequisiteBankDetailAdd, iBXRestParamCrmRequisiteBankDetailDelete, iBXRestParamCrmRequisiteBankDetailGet, iBXRestParamCrmRequisiteBankDetailList, iBXRestParamCrmRequisiteBankDetailUpdate } from '../../../typification/rest/crm';
2
+ /** Банковские реквизиты (`crm.requisite.bankdetail.*`). */
3
+ export declare class BXRestNavvyCrmRequisiteBankDetail {
4
+ private readonly Navvy;
5
+ private readonly url;
6
+ /**
7
+ * Создает банковский реквизит.
8
+ *
9
+ * `ENTITY_ID` — идентификатор родительского реквизита, а набор банковских
10
+ * полей `RQ_*` зависит от `COUNTRY_ID`.
11
+ *
12
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-add.html
13
+ */
14
+ add(param: iBXRestParamCrmRequisiteBankDetailAdd): import("../../../services/navvy").NavvySimple<number, number, iBXRestParamCrmRequisiteBankDetailAdd | undefined>;
15
+ /**
16
+ * Изменяет существующий банковский реквизит.
17
+ *
18
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-update.html
19
+ */
20
+ update(param: iBXRestParamCrmRequisiteBankDetailUpdate): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmRequisiteBankDetailUpdate | undefined>;
21
+ /**
22
+ * Возвращает банковский реквизит по идентификатору.
23
+ *
24
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-get.html
25
+ */
26
+ get(param: iBXRestParamCrmRequisiteBankDetailGet): import("../../../services/navvy").NavvySimple<iBXRestCrmRequisiteBankDetail, iBXRestCrmRequisiteBankDetail, import("../../../typification/rest/crm").iBXRestParamCrmRequisiteGet | undefined>;
27
+ /**
28
+ * Возвращает банковские реквизиты по фильтру.
29
+ *
30
+ * Поддерживает выборку `select`, сортировку `order` и постраничную навигацию.
31
+ *
32
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-list.html
33
+ */
34
+ list(param?: iBXRestParamCrmRequisiteBankDetailList): import("../../../services/navvy").NavvyPag<iBXRestCrmRequisiteBankDetail, iBXRestCrmRequisiteBankDetail, iBXRestParamCrmRequisiteBankDetailList>;
35
+ /**
36
+ * Удаляет банковский реквизит.
37
+ *
38
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-delete.html
39
+ */
40
+ delete(param: iBXRestParamCrmRequisiteBankDetailDelete): import("../../../services/navvy").NavvySimple<boolean, boolean, import("../../../typification/rest/crm").iBXRestParamCrmRequisiteGet | undefined>;
41
+ /**
42
+ * Возвращает формальное описание полей банковских реквизитов.
43
+ *
44
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-fields.html
45
+ */
46
+ fields(): import("../../../services/navvy").NavvySimple<iBXRestCrmRequisiteFieldsDescription, iBXRestCrmRequisiteFieldsDescription, undefined>;
47
+ }
@@ -0,0 +1,66 @@
1
+ import { iBXRestCrmRequisite, iBXRestCrmRequisiteFieldsDescription, iBXRestParamCrmRequisiteAdd, iBXRestParamCrmRequisiteDelete, iBXRestParamCrmRequisiteGet, iBXRestParamCrmRequisiteList, iBXRestParamCrmRequisiteUpdate } from '../../../typification/rest/crm';
2
+ import { BXRestNavvyCrmRequisiteBankDetail } from './bankdetail';
3
+ import { BXRestNavvyCrmRequisiteLink } from './link';
4
+ import { BXRestNavvyCrmRequisitePreset } from './preset/index';
5
+ import { BXRestNavvyCrmRequisiteUserField } from './userfield';
6
+ export * from './bankdetail';
7
+ export * from './link';
8
+ export * from './preset/index';
9
+ export * from './userfield';
10
+ /** Реквизиты компаний и контактов (`crm.requisite.*`). */
11
+ export declare class BXRestNavvyCrmRequisite {
12
+ private readonly Navvy;
13
+ private readonly url;
14
+ /** Банковские реквизиты (`crm.requisite.bankdetail.*`). */
15
+ readonly bankdetail: BXRestNavvyCrmRequisiteBankDetail;
16
+ /** Пользовательские поля реквизитов (`crm.requisite.userfield.*`). */
17
+ readonly userfield: BXRestNavvyCrmRequisiteUserField;
18
+ /** Связи реквизитов с объектами CRM (`crm.requisite.link.*`). */
19
+ readonly link: BXRestNavvyCrmRequisiteLink;
20
+ /** Шаблоны реквизитов (`crm.requisite.preset.*`). */
21
+ readonly preset: BXRestNavvyCrmRequisitePreset;
22
+ /**
23
+ * Создает реквизит компании или контакта.
24
+ *
25
+ * `ENTITY_TYPE_ID` принимает `3` для контакта или `4` для компании.
26
+ * Набор полей `RQ_*` зависит от выбранного `PRESET_ID`.
27
+ *
28
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-add.html
29
+ */
30
+ add(param: iBXRestParamCrmRequisiteAdd): import("../../../services/navvy").NavvySimple<number, number, iBXRestParamCrmRequisiteAdd | undefined>;
31
+ /**
32
+ * Изменяет реквизит, включая его стандартные `RQ_*` и пользовательские `UF_CRM_*` поля.
33
+ *
34
+ * Адреса и банковские реквизиты изменяются отдельными вложенными навигаторами.
35
+ *
36
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-update.html
37
+ */
38
+ update(param: iBXRestParamCrmRequisiteUpdate): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmRequisiteUpdate | undefined>;
39
+ /**
40
+ * Возвращает реквизит по идентификатору.
41
+ *
42
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-get.html
43
+ */
44
+ get(param: iBXRestParamCrmRequisiteGet): import("../../../services/navvy").NavvySimple<iBXRestCrmRequisite, iBXRestCrmRequisite, iBXRestParamCrmRequisiteGet | undefined>;
45
+ /**
46
+ * Возвращает реквизиты по фильтру.
47
+ *
48
+ * Пользовательские поля не входят в результат по умолчанию: нужные `UF_CRM_*`
49
+ * следует явно передать в `select`.
50
+ *
51
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-list.html
52
+ */
53
+ list(param?: iBXRestParamCrmRequisiteList): import("../../../services/navvy").NavvyPag<iBXRestCrmRequisite, iBXRestCrmRequisite, iBXRestParamCrmRequisiteList>;
54
+ /**
55
+ * Удаляет реквизит вместе со связанными адресами, банковскими реквизитами и связями.
56
+ *
57
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-delete.html
58
+ */
59
+ delete(param: iBXRestParamCrmRequisiteDelete): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmRequisiteGet | undefined>;
60
+ /**
61
+ * Возвращает формальное описание полей реквизита, включая зарегистрированные `UF_CRM_*`.
62
+ *
63
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-fields.html
64
+ */
65
+ fields(): import("../../../services/navvy").NavvySimple<iBXRestCrmRequisiteFieldsDescription, iBXRestCrmRequisiteFieldsDescription, undefined>;
66
+ }
@@ -0,0 +1,42 @@
1
+ import { iBXRestCrmRequisiteFieldsDescription, iBXRestCrmRequisiteLinkFields, iBXRestParamCrmRequisiteLinkGet, iBXRestParamCrmRequisiteLinkList, iBXRestParamCrmRequisiteLinkRegister, iBXRestParamCrmRequisiteLinkUnregister } from '../../../typification/rest/crm';
2
+ /** Связи реквизитов с объектами CRM (`crm.requisite.link.*`). */
3
+ export declare class BXRestNavvyCrmRequisiteLink {
4
+ private readonly Navvy;
5
+ private readonly url;
6
+ /**
7
+ * Регистрирует реквизиты покупателя и, при необходимости, продавца у объекта CRM.
8
+ *
9
+ * `REQUISITE_ID`/`BANK_DETAIL_ID` относятся к клиенту, поля с префиксом `MC_` —
10
+ * к своей компании.
11
+ *
12
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-register.html
13
+ */
14
+ register(param: iBXRestParamCrmRequisiteLinkRegister): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmRequisiteLinkRegister | undefined>;
15
+ /**
16
+ * Возвращает связь реквизитов с конкретным объектом CRM.
17
+ *
18
+ * Обратите внимание: API принимает параметры `entityTypeId` и `entityId`
19
+ * в camelCase.
20
+ *
21
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-get.html
22
+ */
23
+ get(param: iBXRestParamCrmRequisiteLinkGet): import("../../../services/navvy").NavvySimple<iBXRestCrmRequisiteLinkFields, iBXRestCrmRequisiteLinkFields, iBXRestParamCrmRequisiteLinkGet | undefined>;
24
+ /**
25
+ * Возвращает список связей реквизитов по фильтру и сортировке.
26
+ *
27
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-list.html
28
+ */
29
+ list(param?: iBXRestParamCrmRequisiteLinkList): import("../../../services/navvy").NavvySimple<iBXRestCrmRequisiteLinkFields[], iBXRestCrmRequisiteLinkFields[], iBXRestParamCrmRequisiteLinkList | undefined>;
30
+ /**
31
+ * Удаляет связь реквизитов с объектом, не удаляя сами реквизиты.
32
+ *
33
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-unregister.html
34
+ */
35
+ unregister(param: iBXRestParamCrmRequisiteLinkUnregister): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmRequisiteLinkGet | undefined>;
36
+ /**
37
+ * Возвращает формальное описание полей связи реквизитов.
38
+ *
39
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-fields.html
40
+ */
41
+ fields(): import("../../../services/navvy").NavvySimple<iBXRestCrmRequisiteFieldsDescription, iBXRestCrmRequisiteFieldsDescription, undefined>;
42
+ }
@@ -0,0 +1,56 @@
1
+ import { iBXRestCrmRequisiteFieldsDescription, iBXRestCrmRequisitePresetField, iBXRestParamCrmRequisitePresetFieldAdd, iBXRestParamCrmRequisitePresetFieldAvailableToAdd, iBXRestParamCrmRequisitePresetFieldDelete, iBXRestParamCrmRequisitePresetFieldGet, iBXRestParamCrmRequisitePresetFieldList, iBXRestParamCrmRequisitePresetFieldUpdate } from '../../../../typification/rest/crm';
2
+ /** Настраиваемые поля шаблона реквизитов (`crm.requisite.preset.field.*`). */
3
+ export declare class BXRestNavvyCrmRequisitePresetField {
4
+ private readonly Navvy;
5
+ private readonly url;
6
+ /**
7
+ * Добавляет настраиваемое поле в шаблон реквизитов.
8
+ *
9
+ * Пользовательское поле `UF_*` сначала нужно создать через
10
+ * `crm.requisite.userfield.add`. Список допустимых полей возвращает `availableToAdd()`.
11
+ *
12
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-add.html
13
+ */
14
+ add(param: iBXRestParamCrmRequisitePresetFieldAdd): import("../../../../services/navvy").NavvySimple<number, number, iBXRestParamCrmRequisitePresetFieldAdd | undefined>;
15
+ /**
16
+ * Изменяет настраиваемое поле заданного шаблона.
17
+ *
18
+ * API ожидает идентификатор поля в верхнерегистровом `ID`, а идентификатор
19
+ * шаблона — в `preset.ID`.
20
+ *
21
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-update.html
22
+ */
23
+ update(param: iBXRestParamCrmRequisitePresetFieldUpdate): import("../../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmRequisitePresetFieldUpdate | undefined>;
24
+ /**
25
+ * Возвращает имена полей, которые еще можно добавить в указанный шаблон.
26
+ *
27
+ * Доступный набор зависит от страны шаблона.
28
+ *
29
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-available-to-add.html
30
+ */
31
+ availableToAdd(param: iBXRestParamCrmRequisitePresetFieldAvailableToAdd): import("../../../../services/navvy").NavvySimple<string[], string[], iBXRestParamCrmRequisitePresetFieldList | undefined>;
32
+ /**
33
+ * Возвращает настраиваемое поле шаблона по идентификатору.
34
+ *
35
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-get.html
36
+ */
37
+ get(param: iBXRestParamCrmRequisitePresetFieldGet): import("../../../../services/navvy").NavvySimple<iBXRestCrmRequisitePresetField, iBXRestCrmRequisitePresetField, iBXRestParamCrmRequisitePresetFieldGet | undefined>;
38
+ /**
39
+ * Возвращает все настраиваемые поля заданного шаблона.
40
+ *
41
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-list.html
42
+ */
43
+ list(param: iBXRestParamCrmRequisitePresetFieldList): import("../../../../services/navvy").NavvySimple<iBXRestCrmRequisitePresetField[], iBXRestCrmRequisitePresetField[], iBXRestParamCrmRequisitePresetFieldList | undefined>;
44
+ /**
45
+ * Удаляет настраиваемое поле из шаблона, не удаляя пользовательское поле `UF_*`.
46
+ *
47
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-delete.html
48
+ */
49
+ delete(param: iBXRestParamCrmRequisitePresetFieldDelete): import("../../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmRequisitePresetFieldGet | undefined>;
50
+ /**
51
+ * Возвращает формальное описание настраиваемых полей шаблона.
52
+ *
53
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-fields.html
54
+ */
55
+ fields(): import("../../../../services/navvy").NavvySimple<iBXRestCrmRequisiteFieldsDescription, iBXRestCrmRequisiteFieldsDescription, undefined>;
56
+ }
@@ -0,0 +1,57 @@
1
+ import { iBXRestCrmRequisiteFieldsDescription, iBXRestCrmRequisitePreset, iBXRestCrmRequisitePresetCountry, iBXRestParamCrmRequisitePresetAdd, iBXRestParamCrmRequisitePresetDelete, iBXRestParamCrmRequisitePresetGet, iBXRestParamCrmRequisitePresetList, iBXRestParamCrmRequisitePresetUpdate } from '../../../../typification/rest/crm';
2
+ import { BXRestNavvyCrmRequisitePresetField } from './field';
3
+ export * from './field';
4
+ /** Шаблоны реквизитов (`crm.requisite.preset.*`). */
5
+ export declare class BXRestNavvyCrmRequisitePreset {
6
+ private readonly Navvy;
7
+ private readonly url;
8
+ /** Настраиваемые поля шаблона (`crm.requisite.preset.field.*`). */
9
+ readonly field: BXRestNavvyCrmRequisitePresetField;
10
+ /**
11
+ * Создает шаблон реквизитов для выбранной страны.
12
+ *
13
+ * Родительский тип шаблона всегда `ENTITY_TYPE_ID: 8`. Доступные страны
14
+ * возвращает `countries()`.
15
+ *
16
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-add.html
17
+ */
18
+ add(param: iBXRestParamCrmRequisitePresetAdd): import("../../../../services/navvy").NavvySimple<number, number, iBXRestParamCrmRequisitePresetAdd | undefined>;
19
+ /**
20
+ * Изменяет существующий шаблон реквизитов.
21
+ *
22
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-update.html
23
+ */
24
+ update(param: iBXRestParamCrmRequisitePresetUpdate): import("../../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmRequisitePresetUpdate | undefined>;
25
+ /**
26
+ * Возвращает страны, для которых Bitrix24 предоставляет наборы полей реквизитов.
27
+ *
28
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-countries.html
29
+ */
30
+ countries(): import("../../../../services/navvy").NavvySimple<iBXRestCrmRequisitePresetCountry[], iBXRestCrmRequisitePresetCountry[], undefined>;
31
+ /**
32
+ * Возвращает шаблон реквизитов по идентификатору.
33
+ *
34
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-get.html
35
+ */
36
+ get(param: iBXRestParamCrmRequisitePresetGet): import("../../../../services/navvy").NavvySimple<iBXRestCrmRequisitePreset, iBXRestCrmRequisitePreset, import("../../../../typification/rest/crm").iBXRestParamCrmRequisiteGet | undefined>;
37
+ /**
38
+ * Возвращает шаблоны реквизитов по фильтру.
39
+ *
40
+ * Поддерживает выборку `select`, сортировку `order` и постраничную навигацию.
41
+ *
42
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-list.html
43
+ */
44
+ list(param?: iBXRestParamCrmRequisitePresetList): import("../../../../services/navvy").NavvyPag<iBXRestCrmRequisitePreset, iBXRestCrmRequisitePreset, iBXRestParamCrmRequisitePresetList>;
45
+ /**
46
+ * Удаляет шаблон реквизитов.
47
+ *
48
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-delete.html
49
+ */
50
+ delete(param: iBXRestParamCrmRequisitePresetDelete): import("../../../../services/navvy").NavvySimple<boolean, boolean, import("../../../../typification/rest/crm").iBXRestParamCrmRequisiteGet | undefined>;
51
+ /**
52
+ * Возвращает формальное описание полей шаблона реквизитов.
53
+ *
54
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-fields.html
55
+ */
56
+ fields(): import("../../../../services/navvy").NavvySimple<iBXRestCrmRequisiteFieldsDescription, iBXRestCrmRequisiteFieldsDescription, undefined>;
57
+ }
@@ -0,0 +1,43 @@
1
+ import { iBXRestCrmRequisiteUserField, iBXRestParamCrmRequisiteUserFieldAdd, iBXRestParamCrmRequisiteUserFieldDelete, iBXRestParamCrmRequisiteUserFieldGet, iBXRestParamCrmRequisiteUserFieldList, iBXRestParamCrmRequisiteUserFieldUpdate } from '../../../typification/rest/crm';
2
+ /** Пользовательские поля реквизитов (`crm.requisite.userfield.*`). */
3
+ export declare class BXRestNavvyCrmRequisiteUserField {
4
+ private readonly Navvy;
5
+ private readonly url;
6
+ /**
7
+ * Создает пользовательское поле реквизита.
8
+ *
9
+ * Передавайте `ENTITY_ID: 'CRM_REQUISITE'`; `FIELD_NAME` задается без префикса
10
+ * `UF_CRM_`. Для типа `enumeration` варианты передаются в `LIST`.
11
+ *
12
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-add.html
13
+ */
14
+ add(param: iBXRestParamCrmRequisiteUserFieldAdd): import("../../../services/navvy").NavvySimple<number, number, iBXRestParamCrmRequisiteUserFieldAdd | undefined>;
15
+ /**
16
+ * Изменяет пользовательское поле реквизита.
17
+ *
18
+ * Тип и символьный код существующего поля изменить нельзя.
19
+ *
20
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-update.html
21
+ */
22
+ update(param: iBXRestParamCrmRequisiteUserFieldUpdate): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamCrmRequisiteUserFieldUpdate | undefined>;
23
+ /**
24
+ * Возвращает пользовательское поле реквизита по идентификатору.
25
+ *
26
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-get.html
27
+ */
28
+ get(param: iBXRestParamCrmRequisiteUserFieldGet): import("../../../services/navvy").NavvySimple<iBXRestCrmRequisiteUserField, iBXRestCrmRequisiteUserField, import("../../../typification/rest/crm").iBXRestParamCrmRequisiteGet | undefined>;
29
+ /**
30
+ * Возвращает пользовательские поля реквизитов по фильтру.
31
+ *
32
+ * Язык подписей можно выбрать через `filter.LANG`.
33
+ *
34
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-list.html
35
+ */
36
+ list(param?: iBXRestParamCrmRequisiteUserFieldList): import("../../../services/navvy").NavvySimple<iBXRestCrmRequisiteUserField[], iBXRestCrmRequisiteUserField[], iBXRestParamCrmRequisiteUserFieldList | undefined>;
37
+ /**
38
+ * Удаляет пользовательское поле реквизита.
39
+ *
40
+ * @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-delete.html
41
+ */
42
+ delete(param: iBXRestParamCrmRequisiteUserFieldDelete): import("../../../services/navvy").NavvySimple<boolean, boolean, import("../../../typification/rest/crm").iBXRestParamCrmRequisiteGet | undefined>;
43
+ }
@@ -12,7 +12,16 @@ import { BXRestNavvyCrmCurrency } from './crm/currency';
12
12
  import { BXRestNavvyCrmStatus } from './crm/status';
13
13
  import { BXRestNavvyCrmDuplicate } from './crm/duplicate/index';
14
14
  import { BXRestNavvyCrmEntity } from './crm/entity';
15
+ import { BXRestNavvyCrmCallList } from './crm/calllist/index';
16
+ import { BXRestNavvyCrmAddress } from './crm/address';
17
+ import { BXRestNavvyCrmRequisite } from './crm/requisite/index';
15
18
  export declare class BXRestNavvyCrm {
19
+ /** Адреса CRM, в том числе адреса реквизитов (`crm.address.*`). */
20
+ readonly address: BXRestNavvyCrmAddress;
21
+ /** Реквизиты, банковские данные, связи и шаблоны (`crm.requisite.*`). */
22
+ readonly requisite: BXRestNavvyCrmRequisite;
23
+ /** Списки обзвона и их участники (`crm.calllist.*`). */
24
+ readonly callList: BXRestNavvyCrmCallList;
16
25
  /** Поиск дубликатов и настройка его полей (`crm.duplicate.*`). */
17
26
  readonly duplicate: BXRestNavvyCrmDuplicate;
18
27
  /** Операции над универсальными CRM-объектами (`crm.entity.*`). */
@@ -0,0 +1,117 @@
1
+ import { iBXRestParamSort } from '../base/sort';
2
+ /** Тип CRM-объектов, участников списка обзвона. */
3
+ export type iBXRestCrmCallListEntityType = 'CONTACT' | 'COMPANY';
4
+ /** Числовой идентификатор типа участника: контакт или компания. */
5
+ export type iBXRestCrmCallListEntityTypeId = 3 | 4;
6
+ /** Параметры метода `crm.calllist.add`. */
7
+ export interface iBXRestParamCrmCallListAdd {
8
+ /** Тип участников создаваемого обзвона. */
9
+ ENTITY_TYPE: iBXRestCrmCallListEntityType;
10
+ /** Идентификаторы контактов или компаний. */
11
+ ENTITIES: number[];
12
+ /** Идентификатор CRM-формы, которая будет показана во время обзвона. */
13
+ WEBFORM_ID?: number;
14
+ }
15
+ /** Параметры метода `crm.calllist.get`. */
16
+ export interface iBXRestParamCrmCallListGet {
17
+ /** Идентификатор списка обзвона. */
18
+ ID: number;
19
+ }
20
+ /** Параметры метода `crm.calllist.update`. */
21
+ export interface iBXRestParamCrmCallListUpdate {
22
+ /** Идентификатор изменяемого списка обзвона. */
23
+ LIST_ID: number;
24
+ /** Тип участников списка. */
25
+ ENTITY_TYPE: iBXRestCrmCallListEntityType;
26
+ /**
27
+ * Полный новый набор идентификаторов контактов или компаний.
28
+ * Метод заменяет существующий состав списка, а не дополняет его.
29
+ */
30
+ ENTITIES: number[];
31
+ /**
32
+ * Новый идентификатор CRM-формы.
33
+ * Если поле не передано, Bitrix24 очищает ранее установленную CRM-форму.
34
+ */
35
+ WEBFORM_ID?: number;
36
+ }
37
+ /** Поля списка обзвона, доступные для выборки. */
38
+ export type iBXRestCrmCallListField = 'ID' | 'DATE_CREATE' | 'CREATED_BY_ID' | 'WEBFORM_ID' | 'ENTITY_TYPE_ID';
39
+ /** Поля списка обзвона, доступные для фильтрации. */
40
+ export type iBXRestCrmCallListFilterField = 'ID' | 'CREATED_BY_ID' | 'WEBFORM_ID' | 'ENTITY_TYPE_ID';
41
+ /** REST-операторы, поддерживаемые фильтром списка обзвонов. */
42
+ export type iBXRestCrmCallListFilterOperator = '>=' | '>' | '<=' | '<' | '@' | '!@' | '=' | '!=' | '!';
43
+ /** Ключ фильтра списка обзвонов с необязательным REST-оператором. */
44
+ export type iBXRestCrmCallListFilterKey = iBXRestCrmCallListFilterField | `${iBXRestCrmCallListFilterOperator}${iBXRestCrmCallListFilterField}`;
45
+ /** Значение фильтра списка обзвонов. */
46
+ export type iBXRestCrmCallListFilterValue = number | string | (number | string)[];
47
+ /** Параметры метода `crm.calllist.list`. */
48
+ export interface iBXRestParamCrmCallListList {
49
+ /** Поля, которые нужно вернуть. По умолчанию возвращаются все доступные поля. */
50
+ SELECT?: iBXRestCrmCallListField[];
51
+ /** Фильтр по полям списка обзвона, включая REST-префиксы операторов. */
52
+ FILTER?: Partial<Record<iBXRestCrmCallListFilterKey, iBXRestCrmCallListFilterValue>>;
53
+ /** Порядок сортировки списка обзвонов. */
54
+ ORDER?: Partial<Record<iBXRestCrmCallListField, iBXRestParamSort>>;
55
+ }
56
+ /** Параметры метода `crm.calllist.items.get`. */
57
+ export interface iBXRestParamCrmCallListItemsGet {
58
+ /** Идентификатор списка обзвона. */
59
+ LIST_ID: number;
60
+ /** Фильтр участников по коду статуса из `crm.calllist.statuslist`. */
61
+ FILTER?: {
62
+ STATUS?: string;
63
+ };
64
+ }
65
+ interface iBXRestCrmCallListBase {
66
+ /** Тип CRM-объектов, включенных в обзвон. */
67
+ ENTITY_TYPE: iBXRestCrmCallListEntityType;
68
+ }
69
+ /** Список обзвона в локальном формате библиотеки. */
70
+ export interface iBXRestCrmCallList extends iBXRestCrmCallListBase {
71
+ /** Идентификатор списка обзвона. */
72
+ ID: number;
73
+ /** Дата и время создания списка. */
74
+ DATE_CREATE: Date;
75
+ /** Идентификатор пользователя, создавшего список. */
76
+ CREATED_BY_ID: number;
77
+ /** Идентификатор связанной CRM-формы. */
78
+ WEBFORM_ID: number;
79
+ /** Числовой идентификатор типа CRM-объекта. */
80
+ ENTITY_TYPE_ID: iBXRestCrmCallListEntityTypeId;
81
+ }
82
+ /** Список обзвона в формате ответа Bitrix24. */
83
+ export interface iBXRestCrmCallListHttp extends iBXRestCrmCallListBase {
84
+ ID: string;
85
+ DATE_CREATE: string;
86
+ CREATED_BY_ID: string;
87
+ WEBFORM_ID: string;
88
+ ENTITY_TYPE_ID: `${iBXRestCrmCallListEntityTypeId}`;
89
+ }
90
+ /**
91
+ * Элемент результата `crm.calllist.list`.
92
+ * Набор полей зависит от параметра `SELECT`.
93
+ */
94
+ export type iBXRestCrmCallListListItem = Partial<iBXRestCrmCallList>;
95
+ /** Элемент результата `crm.calllist.list` в формате ответа Bitrix24. */
96
+ export type iBXRestCrmCallListListItemHttp = Partial<iBXRestCrmCallListHttp>;
97
+ /** Участник списка обзвона. */
98
+ export interface iBXRestCrmCallListItem {
99
+ /** Идентификатор контакта или компании. */
100
+ ID: number;
101
+ /** Код текущего статуса обзвона участника. */
102
+ STATUS: string;
103
+ /** Числовой идентификатор типа CRM-объекта. */
104
+ ENTITY_TYPE: iBXRestCrmCallListEntityTypeId;
105
+ }
106
+ /** Статус участника списка обзвона. */
107
+ export interface iBXRestCrmCallListStatus {
108
+ /** Числовой идентификатор элемента справочника. */
109
+ ID: number;
110
+ /** Отображаемое название статуса. */
111
+ NAME: string;
112
+ /** Позиция статуса в справочнике. */
113
+ SORT: number;
114
+ /** Код статуса для фильтра `crm.calllist.items.get`. */
115
+ STATUS_ID: string;
116
+ }
117
+ export {};
@@ -12,3 +12,5 @@ export * from './currency';
12
12
  export * from './status';
13
13
  export * from './duplicate';
14
14
  export * from './entity';
15
+ export * from './calllist';
16
+ export * from './requisite';