Annofab v111.0 (#295)

* update pyproject.toml * annofab v0.111.0 * version up
kurusugawa-computer · Apr 4, 2021 · 86ba153 · 86ba153
1 parent 2867974
commit 86ba153
Show file tree

Hide file tree

Showing 9 changed files with 906 additions and 396 deletions.
diff --git a/annofabapi/__version__.py b/annofabapi/__version__.py
@@ -1 +1 @@
-__version__ = "0.43.0"
+__version__ = "0.44.0"
diff --git a/annofabapi/dataclass/annotation_specs.py b/annofabapi/dataclass/annotation_specs.py
@@ -183,7 +183,7 @@ class AdditionalDataDefinitionV1Choices(DataClassJsonMixin):
     name: InternationalizationMessage
     """"""
 
-    keybind: List[Keybind]
+    keybind: Optional[List[Keybind]]
     """"""
 
 
@@ -194,34 +194,34 @@ class AdditionalDataDefinitionV1(DataClassJsonMixin):
     additional_data_definition_id: str
     """"""
 
-    read_only: bool
+    read_only: Optional[bool]
     """"""
 
-    name: InternationalizationMessage
+    name: Optional[InternationalizationMessage]
     """"""
 
-    default: AdditionalDataDefaultType
+    default: Optional[AdditionalDataDefaultType]
     """"""
 
-    keybind: List[Keybind]
+    keybind: Optional[List[Keybind]]
     """"""
 
     type: AdditionalDataDefinitionType
     """"""
 
-    choices: List[AdditionalDataDefinitionV1Choices]
+    choices: Optional[List[AdditionalDataDefinitionV1Choices]]
     """"""
 
     regex: Optional[str]
     """"""
 
-    label_ids: List[str]
+    label_ids: Optional[List[str]]
     """リンク属性において、リンク先として指定可能なラベルID（空の場合制限なし）"""
 
     required: Optional[bool]
     """リンク属性において、入力を必須とするかどうか"""
 
-    metadata: Dict[str, str]
+    metadata: Optional[Dict[str, str]]
     """ユーザーが自由に登録できるkey-value型のメタデータです。 """
 
 
@@ -232,25 +232,25 @@ class AdditionalDataDefinitionV2(DataClassJsonMixin):
     additional_data_definition_id: str
     """"""
 
-    read_only: bool
+    read_only: Optional[bool]
     """"""
 
     name: InternationalizationMessage
     """"""
 
-    default: AdditionalDataDefaultType
+    default: Optional[AdditionalDataDefaultType]
     """"""
 
-    keybind: List[Keybind]
+    keybind: Optional[List[Keybind]]
     """"""
 
     type: AdditionalDataDefinitionType
     """"""
 
-    choices: List[AdditionalDataDefinitionV1Choices]
+    choices: Optional[List[AdditionalDataDefinitionV1Choices]]
     """"""
 
-    metadata: Dict[str, str]
+    metadata: Optional[Dict[str, str]]
     """ユーザーが自由に登録できるkey-value型のメタデータです。 """
 
 
@@ -308,10 +308,10 @@ class LabelV1(DataClassJsonMixin):
     annotation_editor_feature: AnnotationEditorFeature
     """"""
 
-    allow_out_of_image_bounds: bool
+    allow_out_of_image_bounds: Optional[bool]
     """"""
 
-    metadata: Dict[str, str]
+    metadata: Optional[Dict[str, str]]
     """ユーザーが自由に登録できるkey-value型のメタデータです。 """
 
 
@@ -346,10 +346,10 @@ class LabelV2(DataClassJsonMixin):
     annotation_editor_feature: AnnotationEditorFeature
     """"""
 
-    allow_out_of_image_bounds: bool
+    allow_out_of_image_bounds: Optional[bool]
     """"""
 
-    metadata: Dict[str, str]
+    metadata: Optional[Dict[str, str]]
     """ユーザーが自由に登録できるkey-value型のメタデータです。 """
 
 

diff --git a/annofabapi/generated_api.py b/annofabapi/generated_api.py
@@ -1430,6 +1430,33 @@ def get_projects_of_organization(
     # NOTE: This method is auto generated by OpenAPI Generator
     #########################################
 
+    def delete_organization_input_data(
+        self, organization_name: str, input_data_set_id: str, input_data_id: str, **kwargs
+    ) -> Tuple[Any, requests.Response]:
+        """入力データセットの入力データ削除
+        https://annofab.com/docs/api/#operation/deleteOrganizationInputData
+
+
+        authorizations: OrganizationAdministrator, ProjectOwner
+
+
+        指定した組織の[入力データセット](#tag/af-organization-input)内で指定した入力データ情報を削除します。
+
+        Args:
+            organization_name (str):  組織名 (required)
+            input_data_set_id (str):  入力データセットID (required)
+            input_data_id (str):  入力データID (required)
+
+        Returns:
+            Tuple[InputData, requests.Response]
+
+
+        """
+        url_path = f"/organizations/{organization_name}/input_data_set/{input_data_set_id}/inputs/{input_data_id}"
+        http_method = "DELETE"
+        keyword_params: Dict[str, Any] = {}
+        return self._request_wrapper(http_method, url_path, **keyword_params)
+
     def get_input_data_set(
         self, organization_name: str, input_data_set_id: str, **kwargs
     ) -> Tuple[Any, requests.Response]:
@@ -1506,6 +1533,73 @@ def get_organization_input_data(
         keyword_params: Dict[str, Any] = {}
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
+    def get_organization_input_data_list(
+        self, organization_name: str, input_data_set_id: str, query_params: Optional[Dict[str, Any]] = None, **kwargs
+    ) -> Tuple[Any, requests.Response]:
+        """入力データセット内の入力データ一括取得
+        https://annofab.com/docs/api/#operation/getOrganizationInputDataList
+
+
+        authorizations: AllOrganizationMember
+
+
+        指定された入力データセットの入力データを検索します。 組織オーナーまたは組織管理者でない場合は自身が所属するプロジェクトの入力データセット内の入力データのみが取得できます。  パフォーマンスのため、結果はページング形式で返ります。全件取得したい場合は、レスポンスを見て、ページ移動してください。
+
+        Args:
+            organization_name (str):  組織名 (required)
+            input_data_set_id (str):  入力データセットID (required)
+            query_params (Dict[str, Any]): Query Parameters
+                input_data_id (str):  入力データIDでの部分一致検索で使用。1文字以上あれば使用します。
+                input_data_name (str):  入力データ名での部分一致検索で使用。1文字以上あれば使用します。
+                input_data_path (str):  入力データパスでの部分一致検索で使用。1文字以上あれば使用します。
+                task_id (str):  入力データが紐づくタスクIDの部分一致検索で使用。1文字以上あれば使用します。条件に合致した先頭100件のタスクに使われている入力データを検索します。
+                _from (str):  更新日時での範囲検索で使用（ISO 8601 拡張形式）
+                to (str):  更新日時での範囲検索で使用（ISO 8601 拡張形式）
+                page (int):  検索結果のうち、取得したいページの番号(1始まり）
+                limit (int):  1ページあたりの取得するデータ件数
+
+        Returns:
+            Tuple[InputDataList, requests.Response]
+
+
+        """
+        url_path = f"/organizations/{organization_name}/input_data_set/{input_data_set_id}/inputs"
+        http_method = "GET"
+        keyword_params: Dict[str, Any] = {
+            "query_params": query_params,
+        }
+        return self._request_wrapper(http_method, url_path, **keyword_params)
+
+    def put_input_data_set(
+        self, organization_name: str, input_data_set_id: str, request_body: Optional[Any] = None, **kwargs
+    ) -> Tuple[Any, requests.Response]:
+        """入力データセット新規作成/更新
+        https://annofab.com/docs/api/#operation/putInputDataSet
+
+
+        authorizations: OrganizationAdministrator, OrganizationOwner
+
+
+        指定した組織の[入力データセット](#tag/af-organization-input)の情報を新規登録/更新します。
+
+        Args:
+            organization_name (str):  組織名 (required)
+            input_data_set_id (str):  入力データセットID (required)
+            request_body (Any): Request Body
+                put_input_data_set_request (PutInputDataSetRequest):
+
+        Returns:
+            Tuple[InputDataSet, requests.Response]
+
+
+        """
+        url_path = f"/organizations/{organization_name}/input_data_set/{input_data_set_id}"
+        http_method = "PUT"
+        keyword_params: Dict[str, Any] = {
+            "request_body": request_body,
+        }
+        return self._request_wrapper(http_method, url_path, **keyword_params)
+
     #########################################
     # Public Method : AfOrganizationMemberApi
     # NOTE: This method is auto generated by OpenAPI Generator

diff --git a/annofabapi/models.py b/annofabapi/models.py
@@ -2763,6 +2763,8 @@ class OrganizationMemberStatus(Enum):
 
 * url: str
     カスタムアノテーション仕様画面の URL です。 プラグイン種別がカスタムアノテーション仕様の場合のみ有効です。  この URL には、プロジェクトを特定するための以下のパラメータを必ず埋め込んでください。  * `{projectId}` 
+* auth_redirect_url: str
+    認証後のリダイレクト先 
 * compatible_input_data_types: List[InputDataType]
     プラグインが対応している入力データです。 プラグイン種別がカスタムアノテーションエディタ、またはカスタムアノテーション仕様の場合のみ有効です。 
 * type: str
@@ -2778,6 +2780,8 @@ class OrganizationMemberStatus(Enum):
 
 * url: str
     カスタムアノテーションエディタでタスクを開くための URL です。 プラグインを使用するプロジェクトのタスク一覧などで使用されます。 プラグイン種別がカスタムアノテーションエディタの場合のみ有効です。  この URL には、タスクを特定するための以下のパラメータを必ず埋め込んでください。  * `{projectId}` * `{taskId}`  以下のパラメーターは任意で指定します。  * `{inputDataId}`: アノテーション一覧などから、特定の入力データにフォーカスした状態でタスクを開くときなどに指定します。 * `{annotationId}`: アノテーション一覧などから、特定のアノテーションにフォーカスした状態でタスクを開くときなどに指定します。 
+* auth_redirect_url: str
+    認証後のリダイレクト先。このURLに `?code=xxx` をつけてリダイレクトされます。 url プロパティとは異なり、 `{projectId}` や `{taskId}` といったパラメータの置換は行われません。  詳しくは [requestPluginToken API](#operation/requestPluginToken) を参照してください。 
 * compatible_input_data_types: List[InputDataType]
     プラグインが対応している入力データです。 プラグイン種別がカスタムアノテーションエディタ、またはカスタムアノテーション仕様の場合のみ有効です。 
 * type: str
@@ -2793,6 +2797,8 @@ class OrganizationMemberStatus(Enum):
 
 * url: str
     カスタムアノテーション仕様画面の URL です。 プラグイン種別がカスタムアノテーション仕様の場合のみ有効です。  この URL には、プロジェクトを特定するための以下のパラメータを必ず埋め込んでください。  * `{projectId}` 
+* auth_redirect_url: str
+    認証後のリダイレクト先 
 * compatible_input_data_types: List[InputDataType]
     プラグインが対応している入力データです。 プラグイン種別がカスタムアノテーションエディタ、またはカスタムアノテーション仕様の場合のみ有効です。 
 * type: str
@@ -2813,6 +2819,64 @@ class OrganizationMemberStatus(Enum):
 
 """
 
+PluginTokenRequest = Dict[str, Any]
+"""
+
+
+Kyes of Dict
+
+* type: str
+    `RefreshToken` を指定します
+* authorization_code: str
+    リダイレクト時にクエリパラメータ `code` として受け取った文字列
+* code_verifier: str
+    認可リクエスト時に渡した `code_challenge` に対応するverifier文字列
+* refresh_token: str
+    前回のトークン発行で得られた `refresh_token`
+
+"""
+
+PluginTokenRequestAuthorizationCode = Dict[str, Any]
+"""
+
+
+Kyes of Dict
+
+* type: str
+    `AuthorizationCode` を指定します
+* authorization_code: str
+    リダイレクト時にクエリパラメータ `code` として受け取った文字列
+* code_verifier: str
+    認可リクエスト時に渡した `code_challenge` に対応するverifier文字列
+
+"""
+
+PluginTokenRequestRefreshToken = Dict[str, Any]
+"""
+
+
+Kyes of Dict
+
+* type: str
+    `RefreshToken` を指定します
+* refresh_token: str
+    前回のトークン発行で得られた `refresh_token`
+
+"""
+
+PluginTokenResponse = Dict[str, Any]
+"""
+
+
+Kyes of Dict
+
+* access_token: str
+    APIアクセスに用いるトークン。 リクエストヘッダにおいて `Authorization: Bearer {access_token}` の形で指定します。 
+* refresh_token: str
+    トークンの更新に用いるトークン。
+
+"""
+
 Point = Dict[str, Any]
 """
 座標
@@ -3239,6 +3303,23 @@ class ProjectStatus(Enum):
 * tasks: List[ProjectTaskStatistics]
     
 
+"""
+
+PutInputDataSetRequest = Dict[str, Any]
+"""
+入力データセット新規作成/更新
+
+Kyes of Dict
+
+* input_data_set_name: str
+    表示用の名前です。
+* input_data_type: InputDataType
+    
+* private_storage_arn: str
+    AWS IAMロール。ビジネスプランでのS3プライベートストレージの認可で使います。 [S3プライベートストレージの認可の設定についてはこちら](/docs/faq/#m0b240)をご覧ください。 
+* last_updated_datetime: str
+    入力データセットの最終更新日時
+
 """
 
 PutMarkersRequest = Dict[str, Any]