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.
- package/consts/part-name-methods.d.ts +10 -0
- package/esm2022/consts/part-name-methods.mjs +11 -1
- package/esm2022/map/crm/calllist.mjs +30 -0
- package/esm2022/map/crm/index.mjs +2 -1
- package/esm2022/request-navvy/crm/address.mjs +66 -0
- package/esm2022/request-navvy/crm/calllist/index.mjs +79 -0
- package/esm2022/request-navvy/crm/calllist/items.mjs +24 -0
- package/esm2022/request-navvy/crm/requisite/bankdetail.mjs +70 -0
- package/esm2022/request-navvy/crm/requisite/index.mjs +89 -0
- package/esm2022/request-navvy/crm/requisite/link.mjs +62 -0
- package/esm2022/request-navvy/crm/requisite/preset/field.mjs +82 -0
- package/esm2022/request-navvy/crm/requisite/preset/index.mjs +83 -0
- package/esm2022/request-navvy/crm/requisite/userfield.mjs +63 -0
- package/esm2022/request-navvy/crm.mjs +10 -1
- package/esm2022/typification/rest/crm/calllist.mjs +2 -0
- package/esm2022/typification/rest/crm/index.mjs +3 -1
- package/esm2022/typification/rest/crm/requisite.mjs +2 -0
- package/fesm2022/bx-rest.mjs +641 -0
- package/fesm2022/bx-rest.mjs.map +1 -1
- package/map/crm/calllist.d.ts +8 -0
- package/map/crm/index.d.ts +1 -0
- package/package.json +1 -1
- package/request-navvy/crm/address.d.ts +46 -0
- package/request-navvy/crm/calllist/index.d.ts +58 -0
- package/request-navvy/crm/calllist/items.d.ts +16 -0
- package/request-navvy/crm/requisite/bankdetail.d.ts +47 -0
- package/request-navvy/crm/requisite/index.d.ts +66 -0
- package/request-navvy/crm/requisite/link.d.ts +42 -0
- package/request-navvy/crm/requisite/preset/field.d.ts +56 -0
- package/request-navvy/crm/requisite/preset/index.d.ts +57 -0
- package/request-navvy/crm/requisite/userfield.d.ts +43 -0
- package/request-navvy/crm.d.ts +9 -0
- package/typification/rest/crm/calllist.d.ts +117 -0
- package/typification/rest/crm/index.d.ts +2 -0
- package/typification/rest/crm/requisite.d.ts +369 -0
package/fesm2022/bx-rest.mjs
CHANGED
|
@@ -1021,6 +1021,9 @@ const $pin = 'pin';
|
|
|
1021
1021
|
const $end = 'end';
|
|
1022
1022
|
const $idle = 'idle';
|
|
1023
1023
|
const $crm = 'crm';
|
|
1024
|
+
const $calllist = 'calllist';
|
|
1025
|
+
const $items = 'items';
|
|
1026
|
+
const $statuslist = 'statuslist';
|
|
1024
1027
|
const $duplicate = 'duplicate';
|
|
1025
1028
|
const $entity = 'entity';
|
|
1026
1029
|
const $findbycomm = 'findbycomm';
|
|
@@ -1039,6 +1042,13 @@ const $deal = 'deal';
|
|
|
1039
1042
|
const $contact = 'contact';
|
|
1040
1043
|
const $company = 'company';
|
|
1041
1044
|
const $quote = 'quote';
|
|
1045
|
+
const $address = 'address';
|
|
1046
|
+
const $requisite = 'requisite';
|
|
1047
|
+
const $bankdetail = 'bankdetail';
|
|
1048
|
+
const $link = 'link';
|
|
1049
|
+
const $preset = 'preset';
|
|
1050
|
+
const $countries = 'countries';
|
|
1051
|
+
const $availabletoadd = 'availabletoadd';
|
|
1042
1052
|
const $currency = 'currency';
|
|
1043
1053
|
const $productrows = 'productrows';
|
|
1044
1054
|
const $documentgenerator = 'documentgenerator';
|
|
@@ -1053,6 +1063,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
|
|
|
1053
1063
|
$accessibility: $accessibility,
|
|
1054
1064
|
$activity: $activity,
|
|
1055
1065
|
$add: $add,
|
|
1066
|
+
$address: $address,
|
|
1056
1067
|
$all: $all,
|
|
1057
1068
|
$api: $api,
|
|
1058
1069
|
$application: $application,
|
|
@@ -1060,11 +1071,14 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
|
|
|
1060
1071
|
$attach: $attach,
|
|
1061
1072
|
$automatedsolution: $automatedsolution,
|
|
1062
1073
|
$automation: $automation,
|
|
1074
|
+
$availabletoadd: $availabletoadd,
|
|
1075
|
+
$bankdetail: $bankdetail,
|
|
1063
1076
|
$bizproc: $bizproc,
|
|
1064
1077
|
$blogcomment: $blogcomment,
|
|
1065
1078
|
$blogpost: $blogpost,
|
|
1066
1079
|
$booking: $booking,
|
|
1067
1080
|
$calendar: $calendar,
|
|
1081
|
+
$calllist: $calllist,
|
|
1068
1082
|
$channel: $channel,
|
|
1069
1083
|
$chat: $chat,
|
|
1070
1084
|
$commentitem: $commentitem,
|
|
@@ -1074,6 +1088,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
|
|
|
1074
1088
|
$contact: $contact,
|
|
1075
1089
|
$copyto: $copyto,
|
|
1076
1090
|
$counters: $counters,
|
|
1091
|
+
$countries: $countries,
|
|
1077
1092
|
$create: $create,
|
|
1078
1093
|
$crm: $crm,
|
|
1079
1094
|
$currency: $currency,
|
|
@@ -1119,9 +1134,11 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
|
|
|
1119
1134
|
$instances: $instances,
|
|
1120
1135
|
$isactionallowed: $isactionallowed,
|
|
1121
1136
|
$item: $item,
|
|
1137
|
+
$items: $items,
|
|
1122
1138
|
$kill: $kill,
|
|
1123
1139
|
$lead: $lead,
|
|
1124
1140
|
$leave: $leave,
|
|
1141
|
+
$link: $link,
|
|
1125
1142
|
$list: $list,
|
|
1126
1143
|
$lists: $lists,
|
|
1127
1144
|
$log: $log,
|
|
@@ -1139,6 +1156,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
|
|
|
1139
1156
|
$pause: $pause,
|
|
1140
1157
|
$pin: $pin,
|
|
1141
1158
|
$planner: $planner,
|
|
1159
|
+
$preset: $preset,
|
|
1142
1160
|
$productrows: $productrows,
|
|
1143
1161
|
$public: $public,
|
|
1144
1162
|
$pull: $pull,
|
|
@@ -1149,6 +1167,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
|
|
|
1149
1167
|
$rename: $rename,
|
|
1150
1168
|
$renew: $renew,
|
|
1151
1169
|
$request: $request,
|
|
1170
|
+
$requisite: $requisite,
|
|
1152
1171
|
$resource: $resource,
|
|
1153
1172
|
$restore: $restore,
|
|
1154
1173
|
$result: $result,
|
|
@@ -1166,6 +1185,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
|
|
|
1166
1185
|
$stages: $stages,
|
|
1167
1186
|
$start: $start,
|
|
1168
1187
|
$status: $status,
|
|
1188
|
+
$statuslist: $statuslist,
|
|
1169
1189
|
$storage: $storage,
|
|
1170
1190
|
$task: $task,
|
|
1171
1191
|
$tasks: $tasks,
|
|
@@ -6263,6 +6283,34 @@ class BXRestMapCrmStatus {
|
|
|
6263
6283
|
}
|
|
6264
6284
|
}
|
|
6265
6285
|
|
|
6286
|
+
class BXRestMapCrmCallList {
|
|
6287
|
+
/** Преобразует данные списка обзвона из формата Bitrix24 в локальный формат. */
|
|
6288
|
+
static get(value) {
|
|
6289
|
+
return this.mapItem(value);
|
|
6290
|
+
}
|
|
6291
|
+
/** Преобразует список обзвонов с учетом полей, выбранных через `SELECT`. */
|
|
6292
|
+
static list(value) {
|
|
6293
|
+
return value?.map(item => this.mapItem(item));
|
|
6294
|
+
}
|
|
6295
|
+
static mapItem(value) {
|
|
6296
|
+
if (!value)
|
|
6297
|
+
return undefined;
|
|
6298
|
+
const result = clone(value);
|
|
6299
|
+
if (value.ID !== undefined)
|
|
6300
|
+
result.ID = toNum(value.ID);
|
|
6301
|
+
if (value.DATE_CREATE !== undefined) {
|
|
6302
|
+
result.DATE_CREATE = toDate(value.DATE_CREATE, 'yyyy-MM-dd HH:mm:ss');
|
|
6303
|
+
}
|
|
6304
|
+
if (value.CREATED_BY_ID !== undefined)
|
|
6305
|
+
result.CREATED_BY_ID = toNum(value.CREATED_BY_ID);
|
|
6306
|
+
if (value.WEBFORM_ID !== undefined)
|
|
6307
|
+
result.WEBFORM_ID = toNum(value.WEBFORM_ID);
|
|
6308
|
+
if (value.ENTITY_TYPE_ID !== undefined)
|
|
6309
|
+
result.ENTITY_TYPE_ID = toNum(value.ENTITY_TYPE_ID);
|
|
6310
|
+
return result;
|
|
6311
|
+
}
|
|
6312
|
+
}
|
|
6313
|
+
|
|
6266
6314
|
class BXRestNavvyCrmLead {
|
|
6267
6315
|
constructor() {
|
|
6268
6316
|
this.url = {
|
|
@@ -7533,8 +7581,601 @@ class BXRestNavvyCrmEntity {
|
|
|
7533
7581
|
}
|
|
7534
7582
|
}
|
|
7535
7583
|
|
|
7584
|
+
/** Участники списка обзвона (`crm.calllist.items.*`). */
|
|
7585
|
+
class BXRestNavvyCrmCallListItems {
|
|
7586
|
+
constructor() {
|
|
7587
|
+
this.Navvy = new Navvy();
|
|
7588
|
+
this.url = {
|
|
7589
|
+
get: [$crm, $calllist, $items, $get]
|
|
7590
|
+
};
|
|
7591
|
+
}
|
|
7592
|
+
/**
|
|
7593
|
+
* Возвращает контакты или компании из списка обзвона вместе с их текущими статусами.
|
|
7594
|
+
*
|
|
7595
|
+
* Для фильтрации передайте `FILTER.STATUS`; доступные коды возвращает
|
|
7596
|
+
* `crm.calllist.statuslist`.
|
|
7597
|
+
*
|
|
7598
|
+
* @param param Идентификатор списка и необязательный фильтр по статусу.
|
|
7599
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-items-get.html
|
|
7600
|
+
*/
|
|
7601
|
+
get(param) {
|
|
7602
|
+
return this.Navvy.simple(this.url.get, param);
|
|
7603
|
+
}
|
|
7604
|
+
}
|
|
7605
|
+
|
|
7606
|
+
/** Навигатор REST-методов списков обзвона (`crm.calllist.*`). */
|
|
7607
|
+
class BXRestNavvyCrmCallList {
|
|
7608
|
+
constructor() {
|
|
7609
|
+
this.Navvy = new Navvy();
|
|
7610
|
+
this.url = {
|
|
7611
|
+
add: [$crm, $calllist, $add],
|
|
7612
|
+
get: [$crm, $calllist, $get],
|
|
7613
|
+
list: [$crm, $calllist, $list],
|
|
7614
|
+
statusList: [$crm, $calllist, $statuslist],
|
|
7615
|
+
update: [$crm, $calllist, $update]
|
|
7616
|
+
};
|
|
7617
|
+
/** Участники списка обзвона (`crm.calllist.items.*`). */
|
|
7618
|
+
this.items = new BXRestNavvyCrmCallListItems();
|
|
7619
|
+
}
|
|
7620
|
+
/**
|
|
7621
|
+
* Создает список обзвона из контактов или компаний.
|
|
7622
|
+
*
|
|
7623
|
+
* В одном списке могут находиться объекты только одного типа, заданного в `ENTITY_TYPE`.
|
|
7624
|
+
*
|
|
7625
|
+
* @param param Тип объектов, их идентификаторы и необязательная CRM-форма.
|
|
7626
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-add.html
|
|
7627
|
+
*/
|
|
7628
|
+
add(param) {
|
|
7629
|
+
return this.Navvy.simple(this.url.add, param);
|
|
7630
|
+
}
|
|
7631
|
+
/**
|
|
7632
|
+
* Возвращает данные списка обзвона по идентификатору без списка участников.
|
|
7633
|
+
*
|
|
7634
|
+
* Участников можно получить через `items.get()`.
|
|
7635
|
+
*
|
|
7636
|
+
* @param param Идентификатор списка обзвона.
|
|
7637
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-get.html
|
|
7638
|
+
*/
|
|
7639
|
+
get(param) {
|
|
7640
|
+
return this.Navvy.simple(this.url.get, param, BXRestMapCrmCallList.get);
|
|
7641
|
+
}
|
|
7642
|
+
/**
|
|
7643
|
+
* Возвращает списки обзвона с выборкой полей, фильтрацией и сортировкой.
|
|
7644
|
+
*
|
|
7645
|
+
* Набор полей каждого элемента результата зависит от `SELECT`.
|
|
7646
|
+
*
|
|
7647
|
+
* @param param Выбираемые поля, фильтр и порядок сортировки.
|
|
7648
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-list.html
|
|
7649
|
+
*/
|
|
7650
|
+
list(param = {}) {
|
|
7651
|
+
return this.Navvy.simple(this.url.list, param, BXRestMapCrmCallList.list);
|
|
7652
|
+
}
|
|
7653
|
+
/**
|
|
7654
|
+
* Возвращает справочник статусов обзвона.
|
|
7655
|
+
*
|
|
7656
|
+
* Значение `STATUS_ID` можно передать в `items.get({ FILTER: { STATUS } })`.
|
|
7657
|
+
* Создание, изменение и удаление статусов выполняется методами `crm.status.*`
|
|
7658
|
+
* со значением `ENTITY_ID: 'CALL_LIST'`.
|
|
7659
|
+
*
|
|
7660
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-statuslist.html
|
|
7661
|
+
*/
|
|
7662
|
+
statusList() {
|
|
7663
|
+
return this.Navvy.simple(this.url.statusList);
|
|
7664
|
+
}
|
|
7665
|
+
/**
|
|
7666
|
+
* Заменяет состав существующего списка обзвона и обновляет связанную CRM-форму.
|
|
7667
|
+
*
|
|
7668
|
+
* `ENTITIES` перезаписывается целиком: чтобы добавить участников, передайте и текущие,
|
|
7669
|
+
* и новые идентификаторы; чтобы удалить — только те, которые должны остаться.
|
|
7670
|
+
* Если `WEBFORM_ID` не передан, ранее установленная CRM-форма будет очищена.
|
|
7671
|
+
*
|
|
7672
|
+
* @param param Идентификатор списка и его новый полный состав.
|
|
7673
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-update.html
|
|
7674
|
+
*/
|
|
7675
|
+
update(param) {
|
|
7676
|
+
return this.Navvy.simple(this.url.update, param);
|
|
7677
|
+
}
|
|
7678
|
+
}
|
|
7679
|
+
|
|
7680
|
+
/** Адреса CRM (`crm.address.*`). Адреса реквизитов отображаются в карточках компаний и контактов. */
|
|
7681
|
+
class BXRestNavvyCrmAddress {
|
|
7682
|
+
constructor() {
|
|
7683
|
+
this.Navvy = new Navvy();
|
|
7684
|
+
this.url = {
|
|
7685
|
+
add: [$crm, $address, $add],
|
|
7686
|
+
update: [$crm, $address, $update],
|
|
7687
|
+
list: [$crm, $address, $list],
|
|
7688
|
+
delete: [$crm, $address, $delete],
|
|
7689
|
+
fields: [$crm, $address, 'fields']
|
|
7690
|
+
};
|
|
7691
|
+
}
|
|
7692
|
+
/**
|
|
7693
|
+
* Добавляет адрес к реквизиту, лиду или поддерживаемому объекту старого режима.
|
|
7694
|
+
*
|
|
7695
|
+
* Адрес уникален по сочетанию `TYPE_ID`, `ENTITY_TYPE_ID` и `ENTITY_ID`.
|
|
7696
|
+
* Типы адресов возвращает `crm.enum.addresstype`, типы объектов — `crm.enum.ownertype`.
|
|
7697
|
+
*
|
|
7698
|
+
* @param param Составной ключ адреса и его почтовые поля.
|
|
7699
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-add.html
|
|
7700
|
+
*/
|
|
7701
|
+
add(param) {
|
|
7702
|
+
return this.Navvy.simple(this.url.add, param);
|
|
7703
|
+
}
|
|
7704
|
+
/**
|
|
7705
|
+
* Изменяет адрес, найденный по составному ключу в `fields`.
|
|
7706
|
+
*
|
|
7707
|
+
* Поля `ANCHOR_TYPE_ID` и `ANCHOR_ID` являются служебными и заполняются автоматически.
|
|
7708
|
+
*
|
|
7709
|
+
* @param param Ключ адреса и изменяемые значения.
|
|
7710
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-update.html
|
|
7711
|
+
*/
|
|
7712
|
+
update(param) {
|
|
7713
|
+
return this.Navvy.simple(this.url.update, param);
|
|
7714
|
+
}
|
|
7715
|
+
/**
|
|
7716
|
+
* Возвращает адреса по фильтру с выборкой полей, сортировкой и пагинацией.
|
|
7717
|
+
*
|
|
7718
|
+
* Для адресов реквизита обычно фильтруют по `ENTITY_TYPE_ID: 8` и идентификатору
|
|
7719
|
+
* реквизита в `ENTITY_ID`.
|
|
7720
|
+
*
|
|
7721
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-list.html
|
|
7722
|
+
*/
|
|
7723
|
+
list(param = {}) {
|
|
7724
|
+
return this.Navvy.pagNav(this.url.list, param);
|
|
7725
|
+
}
|
|
7726
|
+
/**
|
|
7727
|
+
* Удаляет адрес по составному ключу `TYPE_ID`, `ENTITY_TYPE_ID`, `ENTITY_ID`.
|
|
7728
|
+
*
|
|
7729
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-delete.html
|
|
7730
|
+
*/
|
|
7731
|
+
delete(param) {
|
|
7732
|
+
return this.Navvy.simple(this.url.delete, param);
|
|
7733
|
+
}
|
|
7734
|
+
/**
|
|
7735
|
+
* Возвращает формальное описание полей адреса.
|
|
7736
|
+
*
|
|
7737
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/addresses/crm-address-fields.html
|
|
7738
|
+
*/
|
|
7739
|
+
fields() {
|
|
7740
|
+
return this.Navvy.simple(this.url.fields);
|
|
7741
|
+
}
|
|
7742
|
+
}
|
|
7743
|
+
|
|
7744
|
+
/** Банковские реквизиты (`crm.requisite.bankdetail.*`). */
|
|
7745
|
+
class BXRestNavvyCrmRequisiteBankDetail {
|
|
7746
|
+
constructor() {
|
|
7747
|
+
this.Navvy = new Navvy();
|
|
7748
|
+
this.url = {
|
|
7749
|
+
add: [$crm, $requisite, $bankdetail, $add],
|
|
7750
|
+
update: [$crm, $requisite, $bankdetail, $update],
|
|
7751
|
+
get: [$crm, $requisite, $bankdetail, $get],
|
|
7752
|
+
list: [$crm, $requisite, $bankdetail, $list],
|
|
7753
|
+
delete: [$crm, $requisite, $bankdetail, $delete],
|
|
7754
|
+
fields: [$crm, $requisite, $bankdetail, 'fields']
|
|
7755
|
+
};
|
|
7756
|
+
}
|
|
7757
|
+
/**
|
|
7758
|
+
* Создает банковский реквизит.
|
|
7759
|
+
*
|
|
7760
|
+
* `ENTITY_ID` — идентификатор родительского реквизита, а набор банковских
|
|
7761
|
+
* полей `RQ_*` зависит от `COUNTRY_ID`.
|
|
7762
|
+
*
|
|
7763
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-add.html
|
|
7764
|
+
*/
|
|
7765
|
+
add(param) {
|
|
7766
|
+
return this.Navvy.simple(this.url.add, param);
|
|
7767
|
+
}
|
|
7768
|
+
/**
|
|
7769
|
+
* Изменяет существующий банковский реквизит.
|
|
7770
|
+
*
|
|
7771
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-update.html
|
|
7772
|
+
*/
|
|
7773
|
+
update(param) {
|
|
7774
|
+
return this.Navvy.simple(this.url.update, param);
|
|
7775
|
+
}
|
|
7776
|
+
/**
|
|
7777
|
+
* Возвращает банковский реквизит по идентификатору.
|
|
7778
|
+
*
|
|
7779
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-get.html
|
|
7780
|
+
*/
|
|
7781
|
+
get(param) {
|
|
7782
|
+
return this.Navvy.simple(this.url.get, param);
|
|
7783
|
+
}
|
|
7784
|
+
/**
|
|
7785
|
+
* Возвращает банковские реквизиты по фильтру.
|
|
7786
|
+
*
|
|
7787
|
+
* Поддерживает выборку `select`, сортировку `order` и постраничную навигацию.
|
|
7788
|
+
*
|
|
7789
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-list.html
|
|
7790
|
+
*/
|
|
7791
|
+
list(param = {}) {
|
|
7792
|
+
return this.Navvy.pagNav(this.url.list, param);
|
|
7793
|
+
}
|
|
7794
|
+
/**
|
|
7795
|
+
* Удаляет банковский реквизит.
|
|
7796
|
+
*
|
|
7797
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-delete.html
|
|
7798
|
+
*/
|
|
7799
|
+
delete(param) {
|
|
7800
|
+
return this.Navvy.simple(this.url.delete, param);
|
|
7801
|
+
}
|
|
7802
|
+
/**
|
|
7803
|
+
* Возвращает формальное описание полей банковских реквизитов.
|
|
7804
|
+
*
|
|
7805
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/bank-detail/crm-requisite-bank-detail-fields.html
|
|
7806
|
+
*/
|
|
7807
|
+
fields() {
|
|
7808
|
+
return this.Navvy.simple(this.url.fields);
|
|
7809
|
+
}
|
|
7810
|
+
}
|
|
7811
|
+
|
|
7812
|
+
/** Связи реквизитов с объектами CRM (`crm.requisite.link.*`). */
|
|
7813
|
+
class BXRestNavvyCrmRequisiteLink {
|
|
7814
|
+
constructor() {
|
|
7815
|
+
this.Navvy = new Navvy();
|
|
7816
|
+
this.url = {
|
|
7817
|
+
register: [$crm, $requisite, $link, $register],
|
|
7818
|
+
get: [$crm, $requisite, $link, $get],
|
|
7819
|
+
list: [$crm, $requisite, $link, $list],
|
|
7820
|
+
unregister: [$crm, $requisite, $link, $unregister],
|
|
7821
|
+
fields: [$crm, $requisite, $link, 'fields']
|
|
7822
|
+
};
|
|
7823
|
+
}
|
|
7824
|
+
/**
|
|
7825
|
+
* Регистрирует реквизиты покупателя и, при необходимости, продавца у объекта CRM.
|
|
7826
|
+
*
|
|
7827
|
+
* `REQUISITE_ID`/`BANK_DETAIL_ID` относятся к клиенту, поля с префиксом `MC_` —
|
|
7828
|
+
* к своей компании.
|
|
7829
|
+
*
|
|
7830
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-register.html
|
|
7831
|
+
*/
|
|
7832
|
+
register(param) {
|
|
7833
|
+
return this.Navvy.simple(this.url.register, param);
|
|
7834
|
+
}
|
|
7835
|
+
/**
|
|
7836
|
+
* Возвращает связь реквизитов с конкретным объектом CRM.
|
|
7837
|
+
*
|
|
7838
|
+
* Обратите внимание: API принимает параметры `entityTypeId` и `entityId`
|
|
7839
|
+
* в camelCase.
|
|
7840
|
+
*
|
|
7841
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-get.html
|
|
7842
|
+
*/
|
|
7843
|
+
get(param) {
|
|
7844
|
+
return this.Navvy.simple(this.url.get, param);
|
|
7845
|
+
}
|
|
7846
|
+
/**
|
|
7847
|
+
* Возвращает список связей реквизитов по фильтру и сортировке.
|
|
7848
|
+
*
|
|
7849
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-list.html
|
|
7850
|
+
*/
|
|
7851
|
+
list(param = {}) {
|
|
7852
|
+
return this.Navvy.simple(this.url.list, param);
|
|
7853
|
+
}
|
|
7854
|
+
/**
|
|
7855
|
+
* Удаляет связь реквизитов с объектом, не удаляя сами реквизиты.
|
|
7856
|
+
*
|
|
7857
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-unregister.html
|
|
7858
|
+
*/
|
|
7859
|
+
unregister(param) {
|
|
7860
|
+
return this.Navvy.simple(this.url.unregister, param);
|
|
7861
|
+
}
|
|
7862
|
+
/**
|
|
7863
|
+
* Возвращает формальное описание полей связи реквизитов.
|
|
7864
|
+
*
|
|
7865
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/links/crm-requisite-link-fields.html
|
|
7866
|
+
*/
|
|
7867
|
+
fields() {
|
|
7868
|
+
return this.Navvy.simple(this.url.fields);
|
|
7869
|
+
}
|
|
7870
|
+
}
|
|
7871
|
+
|
|
7872
|
+
/** Настраиваемые поля шаблона реквизитов (`crm.requisite.preset.field.*`). */
|
|
7873
|
+
class BXRestNavvyCrmRequisitePresetField {
|
|
7874
|
+
constructor() {
|
|
7875
|
+
this.Navvy = new Navvy();
|
|
7876
|
+
this.url = {
|
|
7877
|
+
add: [$crm, $requisite, $preset, $field, $add],
|
|
7878
|
+
update: [$crm, $requisite, $preset, $field, $update],
|
|
7879
|
+
availableToAdd: [$crm, $requisite, $preset, $field, $availabletoadd],
|
|
7880
|
+
get: [$crm, $requisite, $preset, $field, $get],
|
|
7881
|
+
list: [$crm, $requisite, $preset, $field, $list],
|
|
7882
|
+
delete: [$crm, $requisite, $preset, $field, $delete],
|
|
7883
|
+
fields: [$crm, $requisite, $preset, $field, 'fields']
|
|
7884
|
+
};
|
|
7885
|
+
}
|
|
7886
|
+
/**
|
|
7887
|
+
* Добавляет настраиваемое поле в шаблон реквизитов.
|
|
7888
|
+
*
|
|
7889
|
+
* Пользовательское поле `UF_*` сначала нужно создать через
|
|
7890
|
+
* `crm.requisite.userfield.add`. Список допустимых полей возвращает `availableToAdd()`.
|
|
7891
|
+
*
|
|
7892
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-add.html
|
|
7893
|
+
*/
|
|
7894
|
+
add(param) {
|
|
7895
|
+
return this.Navvy.simple(this.url.add, param);
|
|
7896
|
+
}
|
|
7897
|
+
/**
|
|
7898
|
+
* Изменяет настраиваемое поле заданного шаблона.
|
|
7899
|
+
*
|
|
7900
|
+
* API ожидает идентификатор поля в верхнерегистровом `ID`, а идентификатор
|
|
7901
|
+
* шаблона — в `preset.ID`.
|
|
7902
|
+
*
|
|
7903
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-update.html
|
|
7904
|
+
*/
|
|
7905
|
+
update(param) {
|
|
7906
|
+
return this.Navvy.simple(this.url.update, param);
|
|
7907
|
+
}
|
|
7908
|
+
/**
|
|
7909
|
+
* Возвращает имена полей, которые еще можно добавить в указанный шаблон.
|
|
7910
|
+
*
|
|
7911
|
+
* Доступный набор зависит от страны шаблона.
|
|
7912
|
+
*
|
|
7913
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-available-to-add.html
|
|
7914
|
+
*/
|
|
7915
|
+
availableToAdd(param) {
|
|
7916
|
+
return this.Navvy.simple(this.url.availableToAdd, param);
|
|
7917
|
+
}
|
|
7918
|
+
/**
|
|
7919
|
+
* Возвращает настраиваемое поле шаблона по идентификатору.
|
|
7920
|
+
*
|
|
7921
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-get.html
|
|
7922
|
+
*/
|
|
7923
|
+
get(param) {
|
|
7924
|
+
return this.Navvy.simple(this.url.get, param);
|
|
7925
|
+
}
|
|
7926
|
+
/**
|
|
7927
|
+
* Возвращает все настраиваемые поля заданного шаблона.
|
|
7928
|
+
*
|
|
7929
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-list.html
|
|
7930
|
+
*/
|
|
7931
|
+
list(param) {
|
|
7932
|
+
return this.Navvy.simple(this.url.list, param);
|
|
7933
|
+
}
|
|
7934
|
+
/**
|
|
7935
|
+
* Удаляет настраиваемое поле из шаблона, не удаляя пользовательское поле `UF_*`.
|
|
7936
|
+
*
|
|
7937
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-delete.html
|
|
7938
|
+
*/
|
|
7939
|
+
delete(param) {
|
|
7940
|
+
return this.Navvy.simple(this.url.delete, param);
|
|
7941
|
+
}
|
|
7942
|
+
/**
|
|
7943
|
+
* Возвращает формальное описание настраиваемых полей шаблона.
|
|
7944
|
+
*
|
|
7945
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/fields/crm-requisite-preset-field-fields.html
|
|
7946
|
+
*/
|
|
7947
|
+
fields() {
|
|
7948
|
+
return this.Navvy.simple(this.url.fields);
|
|
7949
|
+
}
|
|
7950
|
+
}
|
|
7951
|
+
|
|
7952
|
+
/** Шаблоны реквизитов (`crm.requisite.preset.*`). */
|
|
7953
|
+
class BXRestNavvyCrmRequisitePreset {
|
|
7954
|
+
constructor() {
|
|
7955
|
+
this.Navvy = new Navvy();
|
|
7956
|
+
this.url = {
|
|
7957
|
+
add: [$crm, $requisite, $preset, $add],
|
|
7958
|
+
update: [$crm, $requisite, $preset, $update],
|
|
7959
|
+
countries: [$crm, $requisite, $preset, $countries],
|
|
7960
|
+
get: [$crm, $requisite, $preset, $get],
|
|
7961
|
+
list: [$crm, $requisite, $preset, $list],
|
|
7962
|
+
delete: [$crm, $requisite, $preset, $delete],
|
|
7963
|
+
fields: [$crm, $requisite, $preset, 'fields']
|
|
7964
|
+
};
|
|
7965
|
+
/** Настраиваемые поля шаблона (`crm.requisite.preset.field.*`). */
|
|
7966
|
+
this.field = new BXRestNavvyCrmRequisitePresetField();
|
|
7967
|
+
}
|
|
7968
|
+
/**
|
|
7969
|
+
* Создает шаблон реквизитов для выбранной страны.
|
|
7970
|
+
*
|
|
7971
|
+
* Родительский тип шаблона всегда `ENTITY_TYPE_ID: 8`. Доступные страны
|
|
7972
|
+
* возвращает `countries()`.
|
|
7973
|
+
*
|
|
7974
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-add.html
|
|
7975
|
+
*/
|
|
7976
|
+
add(param) {
|
|
7977
|
+
return this.Navvy.simple(this.url.add, param);
|
|
7978
|
+
}
|
|
7979
|
+
/**
|
|
7980
|
+
* Изменяет существующий шаблон реквизитов.
|
|
7981
|
+
*
|
|
7982
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-update.html
|
|
7983
|
+
*/
|
|
7984
|
+
update(param) {
|
|
7985
|
+
return this.Navvy.simple(this.url.update, param);
|
|
7986
|
+
}
|
|
7987
|
+
/**
|
|
7988
|
+
* Возвращает страны, для которых Bitrix24 предоставляет наборы полей реквизитов.
|
|
7989
|
+
*
|
|
7990
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-countries.html
|
|
7991
|
+
*/
|
|
7992
|
+
countries() {
|
|
7993
|
+
return this.Navvy.simple(this.url.countries);
|
|
7994
|
+
}
|
|
7995
|
+
/**
|
|
7996
|
+
* Возвращает шаблон реквизитов по идентификатору.
|
|
7997
|
+
*
|
|
7998
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-get.html
|
|
7999
|
+
*/
|
|
8000
|
+
get(param) {
|
|
8001
|
+
return this.Navvy.simple(this.url.get, param);
|
|
8002
|
+
}
|
|
8003
|
+
/**
|
|
8004
|
+
* Возвращает шаблоны реквизитов по фильтру.
|
|
8005
|
+
*
|
|
8006
|
+
* Поддерживает выборку `select`, сортировку `order` и постраничную навигацию.
|
|
8007
|
+
*
|
|
8008
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-list.html
|
|
8009
|
+
*/
|
|
8010
|
+
list(param = {}) {
|
|
8011
|
+
return this.Navvy.pagNav(this.url.list, param);
|
|
8012
|
+
}
|
|
8013
|
+
/**
|
|
8014
|
+
* Удаляет шаблон реквизитов.
|
|
8015
|
+
*
|
|
8016
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-delete.html
|
|
8017
|
+
*/
|
|
8018
|
+
delete(param) {
|
|
8019
|
+
return this.Navvy.simple(this.url.delete, param);
|
|
8020
|
+
}
|
|
8021
|
+
/**
|
|
8022
|
+
* Возвращает формальное описание полей шаблона реквизитов.
|
|
8023
|
+
*
|
|
8024
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/presets/crm-requisite-preset-fields.html
|
|
8025
|
+
*/
|
|
8026
|
+
fields() {
|
|
8027
|
+
return this.Navvy.simple(this.url.fields);
|
|
8028
|
+
}
|
|
8029
|
+
}
|
|
8030
|
+
|
|
8031
|
+
/** Пользовательские поля реквизитов (`crm.requisite.userfield.*`). */
|
|
8032
|
+
class BXRestNavvyCrmRequisiteUserField {
|
|
8033
|
+
constructor() {
|
|
8034
|
+
this.Navvy = new Navvy();
|
|
8035
|
+
this.url = {
|
|
8036
|
+
add: [$crm, $requisite, $userfield, $add],
|
|
8037
|
+
update: [$crm, $requisite, $userfield, $update],
|
|
8038
|
+
get: [$crm, $requisite, $userfield, $get],
|
|
8039
|
+
list: [$crm, $requisite, $userfield, $list],
|
|
8040
|
+
delete: [$crm, $requisite, $userfield, $delete]
|
|
8041
|
+
};
|
|
8042
|
+
}
|
|
8043
|
+
/**
|
|
8044
|
+
* Создает пользовательское поле реквизита.
|
|
8045
|
+
*
|
|
8046
|
+
* Передавайте `ENTITY_ID: 'CRM_REQUISITE'`; `FIELD_NAME` задается без префикса
|
|
8047
|
+
* `UF_CRM_`. Для типа `enumeration` варианты передаются в `LIST`.
|
|
8048
|
+
*
|
|
8049
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-add.html
|
|
8050
|
+
*/
|
|
8051
|
+
add(param) {
|
|
8052
|
+
return this.Navvy.simple(this.url.add, param);
|
|
8053
|
+
}
|
|
8054
|
+
/**
|
|
8055
|
+
* Изменяет пользовательское поле реквизита.
|
|
8056
|
+
*
|
|
8057
|
+
* Тип и символьный код существующего поля изменить нельзя.
|
|
8058
|
+
*
|
|
8059
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-update.html
|
|
8060
|
+
*/
|
|
8061
|
+
update(param) {
|
|
8062
|
+
return this.Navvy.simple(this.url.update, param);
|
|
8063
|
+
}
|
|
8064
|
+
/**
|
|
8065
|
+
* Возвращает пользовательское поле реквизита по идентификатору.
|
|
8066
|
+
*
|
|
8067
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-get.html
|
|
8068
|
+
*/
|
|
8069
|
+
get(param) {
|
|
8070
|
+
return this.Navvy.simple(this.url.get, param);
|
|
8071
|
+
}
|
|
8072
|
+
/**
|
|
8073
|
+
* Возвращает пользовательские поля реквизитов по фильтру.
|
|
8074
|
+
*
|
|
8075
|
+
* Язык подписей можно выбрать через `filter.LANG`.
|
|
8076
|
+
*
|
|
8077
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-list.html
|
|
8078
|
+
*/
|
|
8079
|
+
list(param = {}) {
|
|
8080
|
+
return this.Navvy.simple(this.url.list, param);
|
|
8081
|
+
}
|
|
8082
|
+
/**
|
|
8083
|
+
* Удаляет пользовательское поле реквизита.
|
|
8084
|
+
*
|
|
8085
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/user-fields/crm-requisite-userfield-delete.html
|
|
8086
|
+
*/
|
|
8087
|
+
delete(param) {
|
|
8088
|
+
return this.Navvy.simple(this.url.delete, param);
|
|
8089
|
+
}
|
|
8090
|
+
}
|
|
8091
|
+
|
|
8092
|
+
/** Реквизиты компаний и контактов (`crm.requisite.*`). */
|
|
8093
|
+
class BXRestNavvyCrmRequisite {
|
|
8094
|
+
constructor() {
|
|
8095
|
+
this.Navvy = new Navvy();
|
|
8096
|
+
this.url = {
|
|
8097
|
+
add: [$crm, $requisite, $add],
|
|
8098
|
+
update: [$crm, $requisite, $update],
|
|
8099
|
+
get: [$crm, $requisite, $get],
|
|
8100
|
+
list: [$crm, $requisite, $list],
|
|
8101
|
+
delete: [$crm, $requisite, $delete],
|
|
8102
|
+
fields: [$crm, $requisite, 'fields']
|
|
8103
|
+
};
|
|
8104
|
+
/** Банковские реквизиты (`crm.requisite.bankdetail.*`). */
|
|
8105
|
+
this.bankdetail = new BXRestNavvyCrmRequisiteBankDetail();
|
|
8106
|
+
/** Пользовательские поля реквизитов (`crm.requisite.userfield.*`). */
|
|
8107
|
+
this.userfield = new BXRestNavvyCrmRequisiteUserField();
|
|
8108
|
+
/** Связи реквизитов с объектами CRM (`crm.requisite.link.*`). */
|
|
8109
|
+
this.link = new BXRestNavvyCrmRequisiteLink();
|
|
8110
|
+
/** Шаблоны реквизитов (`crm.requisite.preset.*`). */
|
|
8111
|
+
this.preset = new BXRestNavvyCrmRequisitePreset();
|
|
8112
|
+
}
|
|
8113
|
+
/**
|
|
8114
|
+
* Создает реквизит компании или контакта.
|
|
8115
|
+
*
|
|
8116
|
+
* `ENTITY_TYPE_ID` принимает `3` для контакта или `4` для компании.
|
|
8117
|
+
* Набор полей `RQ_*` зависит от выбранного `PRESET_ID`.
|
|
8118
|
+
*
|
|
8119
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-add.html
|
|
8120
|
+
*/
|
|
8121
|
+
add(param) {
|
|
8122
|
+
return this.Navvy.simple(this.url.add, param);
|
|
8123
|
+
}
|
|
8124
|
+
/**
|
|
8125
|
+
* Изменяет реквизит, включая его стандартные `RQ_*` и пользовательские `UF_CRM_*` поля.
|
|
8126
|
+
*
|
|
8127
|
+
* Адреса и банковские реквизиты изменяются отдельными вложенными навигаторами.
|
|
8128
|
+
*
|
|
8129
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-update.html
|
|
8130
|
+
*/
|
|
8131
|
+
update(param) {
|
|
8132
|
+
return this.Navvy.simple(this.url.update, param);
|
|
8133
|
+
}
|
|
8134
|
+
/**
|
|
8135
|
+
* Возвращает реквизит по идентификатору.
|
|
8136
|
+
*
|
|
8137
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-get.html
|
|
8138
|
+
*/
|
|
8139
|
+
get(param) {
|
|
8140
|
+
return this.Navvy.simple(this.url.get, param);
|
|
8141
|
+
}
|
|
8142
|
+
/**
|
|
8143
|
+
* Возвращает реквизиты по фильтру.
|
|
8144
|
+
*
|
|
8145
|
+
* Пользовательские поля не входят в результат по умолчанию: нужные `UF_CRM_*`
|
|
8146
|
+
* следует явно передать в `select`.
|
|
8147
|
+
*
|
|
8148
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-list.html
|
|
8149
|
+
*/
|
|
8150
|
+
list(param = {}) {
|
|
8151
|
+
return this.Navvy.pagNav(this.url.list, param);
|
|
8152
|
+
}
|
|
8153
|
+
/**
|
|
8154
|
+
* Удаляет реквизит вместе со связанными адресами, банковскими реквизитами и связями.
|
|
8155
|
+
*
|
|
8156
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-delete.html
|
|
8157
|
+
*/
|
|
8158
|
+
delete(param) {
|
|
8159
|
+
return this.Navvy.simple(this.url.delete, param);
|
|
8160
|
+
}
|
|
8161
|
+
/**
|
|
8162
|
+
* Возвращает формальное описание полей реквизита, включая зарегистрированные `UF_CRM_*`.
|
|
8163
|
+
*
|
|
8164
|
+
* @see https://apidocs.bitrix24.ru/api-reference/crm/requisites/universal/crm-requisite-fields.html
|
|
8165
|
+
*/
|
|
8166
|
+
fields() {
|
|
8167
|
+
return this.Navvy.simple(this.url.fields);
|
|
8168
|
+
}
|
|
8169
|
+
}
|
|
8170
|
+
|
|
7536
8171
|
class BXRestNavvyCrm {
|
|
7537
8172
|
constructor() {
|
|
8173
|
+
/** Адреса CRM, в том числе адреса реквизитов (`crm.address.*`). */
|
|
8174
|
+
this.address = new BXRestNavvyCrmAddress();
|
|
8175
|
+
/** Реквизиты, банковские данные, связи и шаблоны (`crm.requisite.*`). */
|
|
8176
|
+
this.requisite = new BXRestNavvyCrmRequisite();
|
|
8177
|
+
/** Списки обзвона и их участники (`crm.calllist.*`). */
|
|
8178
|
+
this.callList = new BXRestNavvyCrmCallList();
|
|
7538
8179
|
/** Поиск дубликатов и настройка его полей (`crm.duplicate.*`). */
|
|
7539
8180
|
this.duplicate = new BXRestNavvyCrmDuplicate();
|
|
7540
8181
|
/** Операции над универсальными CRM-объектами (`crm.entity.*`). */
|