From ae5ed94bc91f2a97c4a94782164bf59422e472b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A1=D1=82=D0=B5=D0=BF=D0=B0=D0=BD=D0=B5=D0=BD=D0=BA?= =?UTF-8?q?=D0=BE=20=D0=9E=D0=BB=D1=8C=D0=B3=D0=B0?= Date: Thu, 18 Feb 2021 10:49:17 +0300 Subject: [PATCH] Change extra_func documentation --- main/extra_func.py | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/main/extra_func.py b/main/extra_func.py index 7a0a2de..d510430 100644 --- a/main/extra_func.py +++ b/main/extra_func.py @@ -10,13 +10,13 @@ class ZendeskAdmin: """ Класс **ZendeskAdmin** существует, чтобы в каждой фунциии отдельно не проверять аккаунт администратора - :param credentials: Полномочия пользователя (первым указывается учетная запись организации в Zendesk) + :param credentials: Полномочия (первым указывается учетная запись организации в Zendesk) :type credentials: :class:`list of dictionaries` - :param email: Email пользователя, указанный в Zendesk + :param email: Email администратора, указанный в env :type email: :class:`email` - :param token: Токен пользователя (формируется в Zendesk) + :param token: Токен администратора (формируется в Zendesk, указывается в env) :type token: :class:`str` - :param password: Пароль пользователя, указанный в Zendesk + :param password: Пароль администратора, указанный в env :type password: :class:`str` """ @@ -31,6 +31,14 @@ class ZendeskAdmin: self.create_admin() def check_user(self, email: str) -> bool: + """ + Функция **check_user** осуществляет проверку существования пользователя в Zendesk + + :param email: Электронная почта пользователя + :type email: :class:`email` + :return: True, если существует, иначе False + :rtype: :class:`bool` + """ return True if self.admin.search(email, type='user') else False def get_user_name(self, email: str) -> str: