Source code for arize._generated.api_client.models.user_created_response
# coding: utf-8
"""
Arize REST API
API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment.
The version of the OpenAPI document: 2.0.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
from __future__ import annotations
import pprint
import re # noqa: F401
import json
from datetime import datetime
from pydantic import BaseModel, ConfigDict, Field, SecretStr, StrictBool, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from arize._generated.api_client.models.invite_mode import InviteMode
from arize._generated.api_client.models.user_role_assignment import UserRoleAssignment
from arize._generated.api_client.models.user_status import UserStatus
from typing import Optional, Set
from typing_extensions import Self
[docs]
class UserCreatedResponse(BaseModel):
"""
UserCreatedResponse
""" # noqa: E501
id: StrictStr = Field(description="Unique identifier for the user")
name: StrictStr = Field(description="Full name of the user")
email: StrictStr = Field(description="Email address of the user")
role: UserRoleAssignment
created_at: datetime = Field(description="Timestamp for when the user was created")
status: UserStatus
is_developer: StrictBool = Field(description="Whether the user has developer permissions (can use the Arize API)")
invite_mode: InviteMode = Field(description="The invite mode used when the user was created.")
temporary_password: Optional[SecretStr] = Field(default=None, description="Temporary password issued when `invite_mode` is `temporary_password`. Only present in the `POST /v2/users` 201 Created response. **Security notice:** this value is returned in the JSON response body (not out-of-band). Callers must treat it as a secret: avoid logging the full response, ensure transport is TLS-only, and instruct the user to change the password on first login. ")
__properties: ClassVar[List[str]] = ["id", "name", "email", "role", "created_at", "status", "is_developer", "invite_mode", "temporary_password"]
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) -> Optional[Self]:
"""Create an instance of UserCreatedResponse 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,
)
# override the default output from pydantic by calling `to_dict()` of role
if self.role:
_dict['role'] = self.role.to_dict()
return _dict
[docs]
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"""Create an instance of UserCreatedResponse from a dict"""
if obj is None:
return None
if not isinstance(obj, dict):
return cls.model_validate(obj)
# raise errors for additional fields in the input
for _key in obj.keys():
if _key not in cls.__properties:
raise ValueError("Error due to additional fields (not defined in UserCreatedResponse) in the input: " + _key)
_obj = cls.model_validate({
"id": obj.get("id"),
"name": obj.get("name"),
"email": obj.get("email"),
"role": UserRoleAssignment.from_dict(obj["role"]) if obj.get("role") is not None else None,
"created_at": obj.get("created_at"),
"status": obj.get("status"),
"is_developer": obj.get("is_developer"),
"invite_mode": obj.get("invite_mode"),
"temporary_password": obj.get("temporary_password")
})
return _obj