Source code for arize._generated.api_client.models.api_key_created

# 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, StrictStr, field_validator
from typing import Any, ClassVar, Dict, List, Optional
from arize._generated.api_client.models.api_key_status import ApiKeyStatus
from typing import Optional, Set
from typing_extensions import Self



class ApiKeyCreated(BaseModel):
    """
    ApiKeyCreated
    """ # noqa: E501
    id: StrictStr = Field(description="Unique identifier for the API key.")
    name: StrictStr = Field(description="User-defined name for the API key.")
    description: Optional[StrictStr] = Field(default=None, description="Optional user-defined description for the API key.")
    key_type: StrictStr = Field(description="Type of the API key. - user - Key associated with a specific user. - service - Key associated with a bot user for service authentication. ")
    status: ApiKeyStatus
    redacted_key: StrictStr = Field(description="Redacted version of the key suitable for display (e.g., \"ak-abc...xyz\").")
    created_at: datetime = Field(description="Timestamp when the key was created.")
    expires_at: Optional[datetime] = Field(default=None, description="Optional timestamp when the key will expire.")
    created_by_user_id: StrictStr = Field(description="ID of the user who created the key.")
    key: StrictStr = Field(description="The full API key value. **Only returned once** at creation or refresh time. Store it securely — it cannot be retrieved again. ")
    __properties: ClassVar[List[str]] = ["id", "name", "description", "key_type", "status", "redacted_key", "created_at", "expires_at", "created_by_user_id", "key"]



    @field_validator('key_type')
    def key_type_validate_enum(cls, value):
        """Validates the enum"""
        if value not in set(['user', 'service']):
            raise ValueError("must be one of enum values ('user', 'service')")
        return value


    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )




    def to_str(self) -> str:
        """Returns the string representation of the model using alias"""
        return pprint.pformat(self.model_dump(by_alias=True))




    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())




    @classmethod
    def from_json(cls, json_str: str) -> Optional[Self]:
        """Create an instance of ApiKeyCreated from a JSON string"""
        return cls.from_dict(json.loads(json_str))




    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




    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of ApiKeyCreated 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 ApiKeyCreated) in the input: " + _key)

        _obj = cls.model_validate({
            "id": obj.get("id"),
            "name": obj.get("name"),
            "description": obj.get("description"),
            "key_type": obj.get("key_type"),
            "status": obj.get("status"),
            "redacted_key": obj.get("redacted_key"),
            "created_at": obj.get("created_at"),
            "expires_at": obj.get("expires_at"),
            "created_by_user_id": obj.get("created_by_user_id"),
            "key": obj.get("key")
        })
        return _obj