Source code for annofabapi.pydantic_models.my_account

"""


No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 1.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
"""

from __future__ import annotations

import json
import pprint
import re  # noqa: F401
from typing import Any, ClassVar, Dict, List, Set

from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
from typing_extensions import Annotated, Self

from annofabapi.pydantic_models.key_layout import KeyLayout
from annofabapi.pydantic_models.lang import Lang


[docs] class MyAccount(BaseModel): """ MyAccount """ account_id: StrictStr = Field(description="アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID) ") user_id: StrictStr = Field(description="ユーザーID。[値の制約についてはこちら。](#section/API-Convention/APIID) ") username: StrictStr = Field(description="ユーザー名") email: StrictStr = Field(description="メールアドレス") lang: Lang biography: Annotated[str, Field(min_length=0, strict=True, max_length=100)] | None = Field( default=None, description="人物紹介、略歴。 この属性は、Annofab外の所属先や肩書などを表すために用います。 Annofab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 ", ) keylayout: KeyLayout authority: StrictStr = Field(description="システム内部用のプロパティ") account_type: StrictStr = Field( description="アカウントの種別 * `annofab` - 通常の手順で登録されたアカウント。後から[外部アカウントとの紐付け](/docs/faq/#yyyub0)をしたアカウントの場合もこちらになります。 * `external` - [外部アカウントだけで作成したアカウント](/docs/faq/#v1u344) * `project_guest` - [issueProjectGuestUserToken](#operation/issueProjectGuestUserToken)によって作成されたされたアカウント " ) updated_datetime: str = Field(description="更新日時") reset_requested_email: StrictStr | None = Field(default=None, description="システム内部用のプロパティ") errors: List[StrictStr] = Field(description="システム内部用のプロパティ") __properties: ClassVar[List[str]] = [ "account_id", "user_id", "username", "email", "lang", "biography", "keylayout", "authority", "account_type", "updated_datetime", "reset_requested_email", "errors", ]
[docs] @field_validator("account_type") def account_type_validate_enum(cls, value): """Validates the enum""" if value not in set(["annofab", "external", "project_guest"]): raise ValueError("must be one of enum values ('annofab', 'external', 'project_guest')") return value
model_config = ConfigDict( populate_by_name=True, validate_assignment=True, protected_namespaces=(), )
[docs] def to_str(self) -> str: """Returns the string representation of the model using alias""" return pprint.pformat(self.model_dump(by_alias=True))
[docs] def to_json(self) -> str: """Returns the JSON representation of the model using alias""" # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict())
[docs] @classmethod def from_json(cls, json_str: str) -> Self | None: """Create an instance of MyAccount from a JSON string""" return cls.from_dict(json.loads(json_str))
[docs] def to_dict(self) -> Dict[str, Any]: """Return the dictionary representation of the model using alias. This has the following differences from calling pydantic's `self.model_dump(by_alias=True)`: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. """ excluded_fields: Set[str] = set([]) _dict = self.model_dump( by_alias=True, exclude=excluded_fields, exclude_none=True, ) return _dict
[docs] @classmethod def from_dict(cls, obj: Dict[str, Any] | None) -> Self | None: """Create an instance of MyAccount from a dict""" if obj is None: return None if not isinstance(obj, dict): return cls.model_validate(obj) _obj = cls.model_validate( { "account_id": obj.get("account_id"), "user_id": obj.get("user_id"), "username": obj.get("username"), "email": obj.get("email"), "lang": obj.get("lang"), "biography": obj.get("biography"), "keylayout": obj.get("keylayout"), "authority": obj.get("authority"), "account_type": obj.get("account_type"), "updated_datetime": obj.get("updated_datetime"), "reset_requested_email": obj.get("reset_requested_email"), "errors": obj.get("errors"), } ) return _obj