userService

userService

• userService
  • GetById(id) ⇒ Promise.<ApiResult>
  • GetByType(queryString) ⇒ Promise.<ApiResult>
  • GetTable(queryString) ⇒ Promise.<ApiResult>
  • Update(body) ⇒ Promise.<ApiResult>
  • DeleteById(id) ⇒ Promise.<ApiResult>
  • AddUnblocked(params) ⇒ Promise.<ApiResult>
  • UpdateBlock(params) ⇒ Promise.<ApiResult>
  • Restore(params) ⇒ Promise.<ApiResult>
  • GetPermissionsById(id) ⇒ Promise.<ApiResult>
  • UpdatePermissions(params) ⇒ Promise.<ApiResult>
  • GetToken(params) ⇒ Promise.<ApiResult>
  • RevokeToken() ⇒ Promise.<ApiResult>
  • CheckToken() ⇒ Promise.<ApiResult>
  • ChangePassword(params) ⇒ Promise.<ApiResult>
  • ChangeLocale(params) ⇒ Promise.<ApiResult>
  • ResendRegistrationCode(params) ⇒ Promise.<ApiResult>
  • ApproveRegistrationCode(params) ⇒ Promise.<ApiResult>
  • ChangePasswordAndSendEmail(params) ⇒ Promise.<ApiResult>
  • ApproveChangePasswordCode(params) ⇒ Promise.<ApiResult>

GetById(id) ⇒ Promise.<ApiResult>

Получает пользователя по ID

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

Param	Type	Description
id	number	ID пользователя

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

Returns: Promise.<ApiResult> - Данные пользователя под полем user

---

GetByType(queryString) ⇒ Promise.<ApiResult>

Получает список пользователей по типам

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

Param	Type	Description
queryString	string	Готовая строка запроса (типы пользователей)

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

Returns: Promise.<ApiResult> - Список пользователей под полем users

---

GetTable(queryString) ⇒ Promise.<ApiResult>

Получает список пользователей с пагинацией и фильтрами

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

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

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

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

---

Update(body) ⇒ Promise.<ApiResult>

Обновляет данные пользователя

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

Param	Type	Description
body	UpdateUserRequestDto	Тело запроса. См. UpdateUserRequestDto

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

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

---

DeleteById(id) ⇒ Promise.<ApiResult>

Удаляет пользователя по ID

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

Param	Type	Description
id	number	ID пользователя

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

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

---

AddUnblocked(params) ⇒ Promise.<ApiResult>

Создаёт нового незаблокированного пользователя

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

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

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

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

---

UpdateBlock(params) ⇒ Promise.<ApiResult>

Обновляет статус блокировки пользователя

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

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

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

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

---

Restore(params) ⇒ Promise.<ApiResult>

Восстанавливает удалённого пользователя

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

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

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

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

---

GetPermissionsById(id) ⇒ Promise.<ApiResult>

Получает права доступа пользователя по ID

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

Param	Type	Description
id	number	ID пользователя

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

Returns: Promise.<ApiResult> - Права доступа под полем permissions

---

UpdatePermissions(params) ⇒ Promise.<ApiResult>

Обновляет права доступа пользователя

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

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

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

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

---

GetToken(params) ⇒ Promise.<ApiResult>

Получает JWT-токен по логину и паролю

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

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

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

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

---

RevokeToken() ⇒ Promise.<ApiResult>

Отзывает JWT-токен текущего пользователя (выход из системы)

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

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

---

CheckToken() ⇒ Promise.<ApiResult>

Проверяет действительность токена авторизации

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

Returns: Promise.<ApiResult> - Результат проверки авторизации

---

ChangePassword(params) ⇒ Promise.<ApiResult>

Изменяет пароль пользователя

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

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

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

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

---

ChangeLocale(params) ⇒ Promise.<ApiResult>

Изменяет локаль пользователя

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

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

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

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

---

ResendRegistrationCode(params) ⇒ Promise.<ApiResult>

Повторно отправляет код подтверждения регистрации

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

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

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

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

---

ApproveRegistrationCode(params) ⇒ Promise.<ApiResult>

Подтверждает код регистрации и активирует учётную запись

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

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

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

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

---

ChangePasswordAndSendEmail(params) ⇒ Promise.<ApiResult>

Генерирует новый пароль и отправляет код подтверждения на email

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

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

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

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

---

ApproveChangePasswordCode(params) ⇒ Promise.<ApiResult>

Подтверждает код смены пароля и устанавливает новый пароль

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

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

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

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

---