contactService

contactService

• contactService
  • GetTable(queryString) ⇒ Promise.<ApiResult>
  • GetById(id) ⇒ Promise.<ApiResult>
  • GetByPhoneNumber(phoneNumber) ⇒ Promise.<ApiResult>
  • GetLinkedPhoneContactsByUserId(params) ⇒ Promise.<ApiResult>
  • GetLinkedEmailContactsByOwnerId(params) ⇒ Promise.<ApiResult>
  • .GetLinkedContacts(id) ⇒ Promise.<ApiResult>
  • GetPhoneLinks(phoneNumber) ⇒ Promise.<ApiResult>
  • AddPhoneLink(params) ⇒ Promise.<ApiResult>
  • AddEmailLink(params) ⇒ Promise.<ApiResult>
  • .Update(params) ⇒ Promise.<ApiResult>
  • GetEmailById(id) ⇒ Promise.<ApiResult>
  • CreatePhone(phoneNumber) ⇒ Promise.<ApiResult>
  • CreateEmail(email) ⇒ Promise.<ApiResult>
  • GetEmailContactsTable(queryString) ⇒ Promise.<ApiResult>

GetTable(queryString) ⇒ Promise.<ApiResult>

Получает список телефонных контактов с пагинацией

Принимаемые параметры

Param	Type	Description
queryString	string	Готовая строка запроса (пагинация)

Возвращаемые данные

Returns: Promise.<ApiResult> - Список контактов под полем pagination

---

GetById(id) ⇒ Promise.<ApiResult>

Получает телефонный контакт по ID

Принимаемые параметры

Param	Type	Description
id	number	ID телефонного контакта

Возвращаемые данные

Returns: Promise.<ApiResult> - Данные контакта под полем contact

---

GetByPhoneNumber(phoneNumber) ⇒ Promise.<ApiResult>

Получает телефонный контакт по номеру телефона

Принимаемые параметры

Param	Type	Description
phoneNumber	string	Номер телефона

Возвращаемые данные

Returns: Promise.<ApiResult> - Данные контакта под полем contact

INFO

Если контакт с таким номером не существует — создаётся новый.

---

GetLinkedPhoneContactsByUserId(params) ⇒ Promise.<ApiResult>

Получает список привязанных телефонных контактов по владельцу

Принимаемые параметры

Param	Type	Description
params	GetLinkedContactsByOwnerRequestParam	Параметры запроса с полями OwnerId (ID владельца) и OwnerType (тип владельца)

Возвращаемые данные

Returns: Promise.<ApiResult> - Список привязок под полем links

---

GetLinkedEmailContactsByOwnerId(params) ⇒ Promise.<ApiResult>

Получает список привязанных email-контактов по владельцу

Принимаемые параметры

Param	Type	Description
params	GetLinkedContactsByOwnerRequestParam	Параметры запроса с полями OwnerId (ID владельца) и OwnerType (тип владельца)

Возвращаемые данные

Returns: Promise.<ApiResult> - Список привязок под полем links

---

contactService.GetLinkedContacts(id) ⇒ Promise.<ApiResult>

Deprecated

Получает привязку телефонного контакта по ID

Принимаемые параметры

Param	Type	Description
id	number	ID привязки

Возвращаемые данные

Returns: Promise.<ApiResult> - Данные привязки под полем link

---

GetPhoneLinks(phoneNumber) ⇒ Promise.<ApiResult>

Получает привязки телефонного контакта по номеру телефона

Принимаемые параметры

Param	Type	Description
phoneNumber	string	Номер телефона

Возвращаемые данные

Returns: Promise.<ApiResult> - Список привязок под полем pagination

---

AddPhoneLink(params) ⇒ Promise.<ApiResult>

Создаёт привязку телефонного контакта к сущности

Принимаемые параметры

Param	Type	Description
params	CreatePhoneLinkRequestDto	Тело запроса. См. CreatePhoneLinkRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Созданная привязка под полем link

---

AddEmailLink(params) ⇒ Promise.<ApiResult>

Создаёт привязку email-контакта к сущности

Принимаемые параметры

Param	Type	Description
params	CreateEmailLinkRequestDto	Тело запроса. См. CreateEmailLinkRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Созданная привязка под полем link

---

contactService.Update(params) ⇒ Promise.<ApiResult>

Deprecated

Обновляет данные контакта

Принимаемые параметры

Param	Type	Description
params	Record.<string, unknown>	Тело запроса с данными контакта

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

---

GetEmailById(id) ⇒ Promise.<ApiResult>

Получает email-контакт по ID

Принимаемые параметры

Param	Type	Description
id	number	ID email-контакта

Возвращаемые данные

Returns: Promise.<ApiResult> - Данные контакта под полем contact

---

CreatePhone(phoneNumber) ⇒ Promise.<ApiResult>

Создаёт новый телефонный контакт

Принимаемые параметры

Param	Type	Description
phoneNumber	string	Номер телефона

Возвращаемые данные

Returns: Promise.<ApiResult> - Созданный контакт под полем contact

---

CreateEmail(email) ⇒ Promise.<ApiResult>

Создаёт новый email-контакт

Принимаемые параметры

Param	Type	Description
email	string	Адрес электронной почты

Возвращаемые данные

Returns: Promise.<ApiResult> - Созданный контакт под полем contact

---

GetEmailContactsTable(queryString) ⇒ Promise.<ApiResult>

Получает список email-контактов с пагинацией

Принимаемые параметры

Param	Type	Description
queryString	string	Готовая строка запроса (пагинация)

Возвращаемые данные

Returns: Promise.<ApiResult> - Список контактов под полем pagination

---