Merge pull request #611 from kurusugawa-computer/af-update

annofab update

Author: tei6

annofabapi/__init__.py

@@ -2,6 +2,7 @@
 from annofabapi.api2 import AnnofabApi2
 from annofabapi.wrapper import Wrapper
 from annofabapi.resource import build, build_from_netrc, build_from_env, Resource
+from annofabapi.exceptions import NotSupportedUserError
 
 from .__version__ import __version__
 
@@ -13,5 +14,6 @@
     "build_from_netrc",
     "build_from_env",
     "Resource",
+    "NotSupportedUserError",
     "__version__",
 ]

annofabapi/api.py

@@ -11,7 +11,7 @@
 from requests.auth import AuthBase
 from requests.cookies import RequestsCookieJar
 
-from annofabapi.exceptions import NotLoggedInError
+from annofabapi.exceptions import NotLoggedInError, NotSupportedUserError
 from annofabapi.generated_api import AbstractAnnofabApi
 
 logger = logging.getLogger(__name__)
@@ -637,6 +637,10 @@ def login(self) -> Tuple[Dict[str, Any], requests.Response]:
 
         response = self._execute_http_request("post", url, json=login_info)
         json_obj = response.json()
+        if "token" not in json_obj:
+            raise NotSupportedUserError(
+                f"ユーザー(ユーザーID: {self.login_user_id})はMFAが有効です。" "MFAが有効なユーザーは、annofab-api-python-clientを利用できません。"
+            )
         self.token_dict = json_obj["token"]
 
         logger.debug("Logged in successfully. user_id = %s", self.login_user_id)

annofabapi/exceptions.py

@@ -66,3 +66,12 @@ def __init__(self, message: str, uploaded_data_hash: str, response_etag: str):
         self.response_etag = response_etag
 
         super().__init__(message)
+
+
+class NotSupportedUserError(Exception):
+    """
+    annofab-api-python-clientでサポートされていないユーザが実行した際のエラー
+    """
+
+    def __init__(self, message: str):
+        super().__init__(message)

annofabapi/generated_api.py

@@ -1072,15 +1072,15 @@ def get_my_notification_messages(
         authorizations: Everyone
 
 
-        自分に届いている通知メッセージを一括で取得します。 自身に届いている通知メッセージが上限(10000件)を超える場合、タイムスタンプが新しい順で上限を超える通知メッセージは取得できません。 また、上限を超える場合、開封済みの通知メッセージの数は、取得可能な通知メッセージ中の集計値となります。詳細はレスポンスの項目を参照ください。
+        自分に届いている通知メッセージを、メッセージの作成日時が新しい順で、一括取得します。 自身に届いている通知メッセージが上限(10000件)を超える場合、上限を超えた分の通知メッセージは取得できません。 また、上限を超える場合、開封済みの通知メッセージの数は、取得可能な通知メッセージ中の集計値となります。詳細はレスポンスの項目を参照ください。
 
         Args:
             query_params (Dict[str, Any]): Query Parameters
                 page (int):  表示するページ番号
                 limit (int):  1ページあたりの取得するデータ件数
 
         Returns:
-            Tuple[GetMyMessagesResponse, requests.Response]
+            Tuple[MyNotificationList, requests.Response]
 
 
         """
@@ -1092,6 +1092,29 @@ def get_my_notification_messages(
         keyword_params.update(**kwargs)
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
+    def get_my_notification_unread_messages_count(self, **kwargs) -> Tuple[Any, requests.Response]:
+        """自分に届いている通知メッセージの未読件数を取得
+        https://annofab.com/docs/api/#operation/getMyNotificationUnreadMessagesCount
+
+
+        authorizations: Everyone
+
+
+        自分に届いている通知メッセージの未読件数を取得します。
+
+        Args:
+
+        Returns:
+            Tuple[MyNotificationUnreadMessagesCount, requests.Response]
+
+
+        """
+        url_path = f"/my/unread-messages-count"
+        http_method = "GET"
+        keyword_params: Dict[str, Any] = {}
+        keyword_params.update(**kwargs)
+        return self._request_wrapper(http_method, url_path, **keyword_params)
+
     def get_my_organizations(self, **kwargs) -> Tuple[Any, requests.Response]:
         """所属組織の一括取得
         https://annofab.com/docs/api/#operation/getMyOrganizations

annofabapi/generated_api2.py

@@ -300,7 +300,7 @@ def get_project_member_v2(
                 cache (str):  CACHE TIMESTAMP
 
         Returns:
-            Tuple[List[ProjectMember], requests.Response]
+            Tuple[ProjectMember, requests.Response]
 
 
         """

annofabapi/models.py

@@ -2721,27 +2721,6 @@ class DefaultAnnotationType(Enum):
 
 """
 
-GetMyMessagesResponse = Dict[str, Any]
-"""
-自分に届いているユーザー通知の取得結果です。
-
-Kyes of Dict
-
-* values: List[MyNotificationMessage]
-    
-* opened: int
-    開封済みの通知メッセージの数。 over_limitがtrueの場合、メッセージのタイムスタンプが新しい順から10000件のメッセージをもとに集計される 
-* total: int
-    通知メッセージの総数 
-* page: int
-    messagesに含まれる通知メッセージが何ページ目のものか 
-* page_total: int
-    ページ数の総数 
-* over_limit: bool
-    通知メッセージの取得上限を超えているか 
-
-"""
-
 
 class GraphType(Enum):
     """
@@ -2785,6 +2764,30 @@ class GraphType(Enum):
 
 """
 
+InitiateMfaSetupRequest = Dict[str, Any]
+"""
+
+
+Kyes of Dict
+
+* access_token: str
+    アクセストークン。[login](#operation/login) APIで取得します。 
+
+"""
+
+InitiateMfaSetupResponse = Dict[str, Any]
+"""
+
+
+Kyes of Dict
+
+* secret_code: str
+    TOTPアルゴリズムでワンタイムコードを生成するために使用される、一意に生成された共有秘密コードです。 
+* qr_code_data: str
+    MFAを有効化する際、認証アプリで読み込むQRコードに埋め込むデータです。Google AuthenticatorとIIJ SmartKeyに対応しています。 
+
+"""
+
 InputData = Dict[str, Any]
 """
 入力データの情報を表すデータ構造です。
@@ -3484,6 +3487,17 @@ class Lang(Enum):
     JA_JP = "ja-JP"
 
 
+LoginNeedChallengeResponse = Dict[str, Any]
+"""
+
+
+Kyes of Dict
+
+* session: str
+    セッション
+
+"""
+
 LoginRequest = Dict[str, Any]
 """
 
@@ -3497,10 +3511,36 @@ class Lang(Enum):
 
 """
 
+LoginRespondToAuthChallengeRequest = Dict[str, Any]
+"""
+
+
+Kyes of Dict
+
+* mfa_code: str
+    MFAコード。Time-based One-time Password (TOTP) のみ対応している
+* session: str
+    [login API](#operation/login)が返したセッション 
+
+"""
+
 LoginResponse = Dict[str, Any]
 """
 
 
+Kyes of Dict
+
+* token: Token
+    
+* session: str
+    セッション
+
+"""
+
+LoginSucceedResponse = Dict[str, Any]
+"""
+
+
 Kyes of Dict
 
 * token: Token
@@ -3584,6 +3624,17 @@ class Lang(Enum):
 
 """
 
+MfaSetting = Dict[str, Any]
+"""
+
+
+Kyes of Dict
+
+* enabled: bool
+    MFAが有効か (trueの場合に有効)
+
+"""
+
 MyAccount = Dict[str, Any]
 """
 
@@ -3630,6 +3681,27 @@ class Lang(Enum):
 
 """
 
+MyNotificationList = Dict[str, Any]
+"""
+自分に届いているユーザー通知の取得結果です。
+
+Kyes of Dict
+
+* messages: List[MyNotificationMessage]
+    
+* opened: int
+    開封済みの通知メッセージの数。 over_limitがtrueの場合、メッセージのタイムスタンプが新しい順から10000件のメッセージをもとに集計される 
+* total: int
+    通知メッセージの総数 
+* page: int
+    messagesに含まれる通知メッセージが何ページ目のものか 
+* page_total: int
+    ページ数の総数 
+* over_limit: bool
+    通知メッセージの取得上限を超えているか 
+
+"""
+
 MyNotificationMessage = Dict[str, Any]
 """
 自分への通知メッセージの情報です。
@@ -3648,6 +3720,19 @@ class Lang(Enum):
     自身がメッセージを開封したか(開封済みの場合true) 
 * timestamp: str
     最後に通知メッセージ内容を更新した日時。更新がない場合はメッセージ作成日時 
+* created_datetime: str
+    メッセージ作成日時 
+
+"""
+
+MyNotificationUnreadMessagesCount = Dict[str, Any]
+"""
+通知メッセージの未読件数
+
+Kyes of Dict
+
+* unread: int
+    通知メッセージの未読件数
 
 """
 
@@ -4232,6 +4317,21 @@ class OrganizationMemberStatus(Enum):
 * job: ProjectJobInfo
     
 
+"""
+
+PostMfaSettingRequest = Dict[str, Any]
+"""
+
+
+Kyes of Dict
+
+* enabled: bool
+    MFAをONにするか
+* mfa_code: str
+    [initiateMfaSetup](#operation/initiateMfaSetup)が返したシークレットコードを元に生成したTOTP。enabledがtrueの場合に設定する 
+* access_token: str
+    アクセストークン。enabledがtrueの場合に設定する
+
 """
 
 PostProjectTasksUpdateResponse = Dict[str, Any]